diff --git a/nbproject/project.properties b/nbproject/project.properties index 863d6fed..ebfd2b40 100644 --- a/nbproject/project.properties +++ b/nbproject/project.properties @@ -17,7 +17,8 @@ modules=\ ${project.org.antlr.works.branding}:\ ${project.org.antlr.v4}:\ ${project.org.antlr.v4.runtime}:\ - ${project.org.abego.treelayout.core} + ${project.org.abego.treelayout.core}:\ + ${project.org.tvl.netbeans.editor.whitespace} project.org.abego.treelayout.core=org-abego-treelayout-core project.org.antlr=org-antlr project.org.antlr.netbeans=org-antlr-netbeans @@ -28,3 +29,4 @@ project.org.antlr.works.branding=org-antlr-works-branding project.org.antlr.works.editor=org-antlr-works-editor project.org.antlr.works.openfile=org-antlr-works-utilities-openfile project.org.stringtemplate.v4=org-stringtemplate-v4 +project.org.tvl.netbeans.editor.whitespace=tvl.editor.whitespace diff --git a/tvl.editor.whitespace/build.xml b/tvl.editor.whitespace/build.xml new file mode 100644 index 00000000..8a8bcc03 --- /dev/null +++ b/tvl.editor.whitespace/build.xml @@ -0,0 +1,8 @@ + + + + + + Builds, tests, and runs the project org.tvl.netbeans.editor.whitespace. + + diff --git a/tvl.editor.whitespace/manifest.mf b/tvl.editor.whitespace/manifest.mf new file mode 100644 index 00000000..77e4c570 --- /dev/null +++ b/tvl.editor.whitespace/manifest.mf @@ -0,0 +1,5 @@ +Manifest-Version: 1.0 +OpenIDE-Module: org.tvl.netbeans.editor.whitespace +OpenIDE-Module-Localizing-Bundle: org/tvl/netbeans/editor/whitespace/Bundle.properties +OpenIDE-Module-Specification-Version: 1.0 + diff --git a/tvl.editor.whitespace/nbproject/build-impl.xml b/tvl.editor.whitespace/nbproject/build-impl.xml new file mode 100644 index 00000000..2a60e082 --- /dev/null +++ b/tvl.editor.whitespace/nbproject/build-impl.xml @@ -0,0 +1,45 @@ + + + + + + + + + + + + + You must set 'suite.dir' to point to your containing module suite + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tvl.editor.whitespace/nbproject/project.properties b/tvl.editor.whitespace/nbproject/project.properties new file mode 100644 index 00000000..17255bac --- /dev/null +++ b/tvl.editor.whitespace/nbproject/project.properties @@ -0,0 +1,2 @@ +javac.source=1.6 +javac.compilerargs=-Xlint -Xlint:-serial diff --git a/tvl.editor.whitespace/nbproject/project.xml b/tvl.editor.whitespace/nbproject/project.xml new file mode 100644 index 00000000..08438104 --- /dev/null +++ b/tvl.editor.whitespace/nbproject/project.xml @@ -0,0 +1,65 @@ + + + org.netbeans.modules.apisupport.project + + + org.tvl.netbeans.editor.whitespace + + + + org.netbeans.api.annotations.common + + + + 1 + 1.13 + + + + org.netbeans.modules.editor.lib2 + + + + 1 + 1.54.0.25 + + + + org.netbeans.modules.editor.mimelookup + + + + 1 + 1.25 + + + + org.netbeans.modules.editor.settings + + + + 1 + 1.39 + + + + org.openide.util + + + + 8.22 + + + + org.openide.util.lookup + + + + 8.12 + + + + + + + diff --git a/tvl.editor.whitespace/nbproject/suite.properties b/tvl.editor.whitespace/nbproject/suite.properties new file mode 100644 index 00000000..29d7cc9b --- /dev/null +++ b/tvl.editor.whitespace/nbproject/suite.properties @@ -0,0 +1 @@ +suite.dir=${basedir}/.. diff --git a/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/Bundle.properties b/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/Bundle.properties new file mode 100644 index 00000000..c10a15d2 --- /dev/null +++ b/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/Bundle.properties @@ -0,0 +1 @@ +OpenIDE-Module-Name=Editor Whitespace diff --git a/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/WhitespaceHighlighter.java b/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/WhitespaceHighlighter.java new file mode 100644 index 00000000..2ea8f22b --- /dev/null +++ b/tvl.editor.whitespace/src/org/tvl/netbeans/editor/whitespace/WhitespaceHighlighter.java @@ -0,0 +1,274 @@ +/* + * [The "BSD license"] + * Copyright (c) 2012 Sam Harwell + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.tvl.netbeans.editor.whitespace; + +import java.awt.Color; +import javax.swing.event.DocumentEvent; +import javax.swing.event.DocumentListener; +import javax.swing.text.AttributeSet; +import javax.swing.text.BadLocationException; +import javax.swing.text.Document; +import javax.swing.text.MutableAttributeSet; +import javax.swing.text.SimpleAttributeSet; +import javax.swing.text.StyleConstants; +import javax.swing.text.StyledDocument; +import org.netbeans.api.annotations.common.NonNull; +import org.netbeans.api.editor.mimelookup.MimeLookup; +import org.netbeans.api.editor.mimelookup.MimePath; +import org.netbeans.api.editor.mimelookup.MimeRegistration; +import org.netbeans.api.editor.settings.FontColorSettings; +import org.netbeans.spi.editor.highlighting.HighlightsLayer; +import org.netbeans.spi.editor.highlighting.HighlightsLayerFactory; +import org.netbeans.spi.editor.highlighting.HighlightsSequence; +import org.netbeans.spi.editor.highlighting.ZOrder; +import org.netbeans.spi.editor.highlighting.support.AbstractHighlightsContainer; +import org.openide.util.Exceptions; +import org.openide.util.Lookup; +import org.openide.util.Parameters; +import org.openide.util.WeakListeners; + +/** + * + * @author Sam Harwell + */ +public class WhitespaceHighlighter extends AbstractHighlightsContainer { + private final StyledDocument document; + private final AttributeSet attributes; + + protected WhitespaceHighlighter(@NonNull StyledDocument document) { + Parameters.notNull("document", document); + + this.document = document; + + Lookup lookup = MimeLookup.getLookup(MimePath.EMPTY); + FontColorSettings settings = lookup.lookup(FontColorSettings.class); + this.attributes = getFontAndColors(settings, "whitespace"); + + if (this.attributes != null) { + this.document.addDocumentListener(WeakListeners.document(new DocumentListenerImpl(), document)); + } + } + + protected StyledDocument getDocument() { + return document; + } + + protected static AttributeSet getFontAndColors(FontColorSettings settings, String category) { + AttributeSet attributes = settings.getTokenFontColors(category); + return attributes; + } + + @Override + public HighlightsSequence getHighlights(int startOffset, int endOffset) { + if (attributes == null) { + return HighlightsSequence.EMPTY; + } + + return new HighlightsSequenceImpl(document, startOffset, endOffset, attributes); + } + + @MimeRegistration(mimeType="", service=HighlightsLayerFactory.class) + public static class LayerFactory implements HighlightsLayerFactory { + + @Override + public HighlightsLayer[] createLayers(Context context) { + Document document = context.getDocument(); + if (!(document instanceof StyledDocument)) { + return new HighlightsLayer[0]; + } + + WhitespaceHighlighter highlighter = (WhitespaceHighlighter)document.getProperty(WhitespaceHighlighter.class); + if (highlighter == null) { + highlighter = createHighlighter(context); + document.putProperty(WhitespaceHighlighter.class, highlighter); + } + + return new HighlightsLayer[] { HighlightsLayer.create(WhitespaceHighlighter.class.getName(), getPosition(), true, highlighter) }; + } + + protected WhitespaceHighlighter createHighlighter(Context context) { + return new WhitespaceHighlighter((StyledDocument)context.getDocument()); + } + + protected ZOrder getPosition() { + return ZOrder.SYNTAX_RACK.forPosition(1000); + } + } + + public class DocumentListenerImpl implements DocumentListener { + + @Override + public void insertUpdate(DocumentEvent e) { + fireHighlightsChange(e.getOffset(), e.getOffset() + e.getLength()); + } + + @Override + public void removeUpdate(DocumentEvent e) { + } + + @Override + public void changedUpdate(DocumentEvent e) { + fireHighlightsChange(e.getOffset(), e.getOffset() + e.getLength()); + } + + } + + protected static class HighlightsSequenceImpl implements HighlightsSequence { + private static final int BLOCK_SIZE = 1024; + private static final AttributeSet newlineAttributes; + + private final StyledDocument document; + private final int startOffset; + private final int endOffset; + private final AttributeSet attributes; + + private int currentOffset; + private int currentBlockOffset; + private String currentBlock; + + private int currentWhitespaceStart; + private int currentWhitespaceEnd; + private boolean currentNewline; + private boolean finished; + + static { + MutableAttributeSet attributes = new SimpleAttributeSet(); + attributes.addAttribute(StyleConstants.Foreground, new Color(0, 0, 0, 0)); + newlineAttributes = attributes.copyAttributes(); + } + + private HighlightsSequenceImpl(@NonNull StyledDocument document, int startOffset, int endOffset, @NonNull AttributeSet attributes) { + Parameters.notNull("document", document); + Parameters.notNull("attributes", attributes); + + this.document = document; + this.startOffset = startOffset; + this.endOffset = Math.min(endOffset, document.getLength()); + this.attributes = attributes; + + this.currentOffset = startOffset; + this.currentBlockOffset = startOffset; + this.currentBlock = ""; + } + + @Override + public boolean moveNext() { + if (finished) { + return false; + } + + int whitespaceStart = Integer.MAX_VALUE; + boolean inWhitespace = false; + boolean newline = false; + + searchLoop: + while (currentOffset < endOffset) { + int offsetInBlock = currentOffset - currentBlockOffset; + while (offsetInBlock >= currentBlock.length()) { + int previousBlockEnd = currentBlockOffset + currentBlock.length(); + if (!nextBlock()) { + break searchLoop; + } + + int currentBlockEnd = currentBlockOffset + currentBlock.length(); + assert currentBlockEnd > previousBlockEnd : "Whitespace search terminated due to lack of forward progress."; // NOI18N + if (currentBlockEnd <= previousBlockEnd) { + break searchLoop; + } + + offsetInBlock = currentOffset - currentBlockOffset; + } + + char c = currentBlock.charAt(offsetInBlock); + if (inWhitespace) { + if (newline && c != '\n' && c != '\r') { + break; + } else if (!newline && (!Character.isWhitespace(c) || c == '\n' || c == '\r')) { + break; + } + } else if (Character.isWhitespace(c)) { + whitespaceStart = currentOffset; + inWhitespace = true; + newline = c == '\r' || c == '\n'; + } + + currentOffset++; + } + + if (currentOffset > whitespaceStart) { + currentWhitespaceStart = whitespaceStart; + currentWhitespaceEnd = currentOffset; + currentNewline = newline; + return true; + } else { + currentWhitespaceStart = currentOffset; + currentWhitespaceEnd = currentOffset; + currentNewline = false; + return false; + } + } + + @Override + public int getStartOffset() { + return currentWhitespaceStart; + } + + @Override + public int getEndOffset() { + return currentWhitespaceEnd; + } + + @Override + public AttributeSet getAttributes() { + return currentNewline ? newlineAttributes : attributes; + } + + private boolean nextBlock() { + int blockStart = currentBlockOffset + currentBlock.length(); + int blockEnd = Math.min(endOffset, blockStart + BLOCK_SIZE); + + if (blockEnd == blockStart) { + currentBlock = ""; + currentBlockOffset = endOffset; + finished = true; + return false; + } + + try { + currentBlock = document.getText(blockStart, blockEnd - blockStart); + currentBlockOffset = blockStart; + return true; + } catch (BadLocationException ex) { + Exceptions.printStackTrace(ex); + finished = true; + return false; + } + } + } + +}