Merge pull request #711 from csmith/master

Extract interfaces for BackBuffer and IRCDocument.

api/src/main/java/com/dmdirc/ui/messages/Document.java

@@ -0,0 +1,69 @@
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.events.DisplayPropertyMap;
+import java.time.LocalDateTime;
+
+/**
+ * Models the content of a window, as a series of lines.
+ */
+public interface Document {
+
+    /**
+     * Returns the number of lines in this document.
+     *
+     * @return Number of lines
+     */
+    int getNumLines();
+
+    /**
+     * Returns the Line at the specified number.
+     *
+     * @param lineNumber Line number to retrieve
+     *
+     * @return Line at the specified number or null
+     */
+    Line getLine(int lineNumber);
+
+    /**
+     * Adds the stylised string to the canvas.
+     *
+     * @param timestamp The timestamp to show along with the text.
+     * @param displayPropertyMap The display properties to use
+     * @param text stylised string to add to the document
+     */
+    void addText(LocalDateTime timestamp, DisplayPropertyMap displayPropertyMap, String text);
+
+    /**
+     * Trims the document to the specified number of lines.
+     *
+     * @param numLines Number of lines to trim the document to
+     */
+    void trim(int numLines);
+
+    /** Clears all lines from the document. */
+    void clear();
+
+    /**
+     * Adds a DocumentListener to the listener list.
+     *
+     * @param listener Listener to add
+     */
+    void addIRCDocumentListener(DocumentListener listener);
+
+    /**
+     * Removes a DocumentListener from the listener list.
+     *
+     * @param listener Listener to remove
+     */
+    void removeIRCDocumentListener(DocumentListener listener);
+
+    /**
+     * Returns the line height of the specified.
+     *
+     * @param line Line
+     *
+     * @return Line height
+     */
+    int getLineHeight(int line);
+
+}

src/main/java/com/dmdirc/ui/messages/IRCDocumentListener.java → api/src/main/java/com/dmdirc/ui/messages/DocumentListener.java

@@ -25,9 +25,9 @@ package com.dmdirc.ui.messages;
 import java.util.EventListener;
 
 /**
- * Interface for IRCDocument listeners.
+ * Interface for document listeners.
  */
-public interface IRCDocumentListener extends EventListener {
+public interface DocumentListener extends EventListener {
 
     /**
      * A line has been added to the textpane.

api/src/main/java/com/dmdirc/ui/messages/Line.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.events.DisplayProperty;
+import java.util.Optional;
+
+/**
+ * Represents a line of text in IRC.
+ */
+public interface Line {
+
+    /**
+     * Returns the length of the specified line.
+     *
+     * @return Length of the line
+     */
+    int getLength();
+
+    /**
+     * Returns the height of the specified line.
+     *
+     * @return Line height
+     */
+    int getFontSize();
+
+    /**
+     * Sets the default font size for this line.
+     *
+     * @param fontSize New default font size
+     */
+    void setFontSize(final int fontSize);
+
+    /**
+     * Sets the default font name for this line.
+     *
+     * @param fontName New default font name
+     */
+    void setFontName(final String fontName);
+
+    /**
+     * Returns the Line text at the specified number.
+     *
+     * @return Line at the specified number or null
+     */
+    String getText();
+
+    /**
+     * Returns the Line text at the specified number.
+     *
+     * @return Line at the specified number or null
+     *
+     * @since 0.6.3m1
+     */
+    String getStyledText();
+
+    /**
+     * Converts a StyledDocument into an AttributedString.
+     *
+     * @return AttributedString representing the specified StyledDocument
+     */
+    <T> T getStyled(final StyledMessageMaker<T> maker);
+
+    <T> Optional<T> getDisplayableProperty(DisplayProperty<T> property);
+}

src/main/java/com/dmdirc/FrameContainer.java

@@ -37,6 +37,7 @@ import com.dmdirc.interfaces.config.ConfigChangeListener;
 import com.dmdirc.parser.common.CompositionState;
 import com.dmdirc.ui.messages.BackBuffer;
 import com.dmdirc.ui.messages.BackBufferFactory;
+import com.dmdirc.ui.messages.BackBufferImpl;
 import com.dmdirc.ui.messages.UnreadStatusManager;
 
 import java.util.Collection;
@@ -72,7 +73,7 @@ public class FrameContainer implements WindowModel {
     /** The back buffer factory. */
     private final BackBufferFactory backBufferFactory;
     /** The back buffer for this container. */
-    private BackBuffer backBuffer;
+    private BackBufferImpl backBuffer;
     /** The input model for this container. */
     private Optional<InputModel> inputModel = Optional.empty();
     /** The connection associated with this model. */
@@ -208,7 +209,7 @@ public class FrameContainer implements WindowModel {
         eventBus.unsubscribe(unreadStatusManager);
         configManager.getBinder().unbind(unreadStatusManager);
         eventBus.publish(new FrameClosingEvent(this));
-        getBackBuffer().stopAddingEvents();
+        backBuffer.stopAddingEvents();
     }
 
     @Override

src/main/java/com/dmdirc/ui/messages/BackBuffer.java

@@ -22,86 +22,14 @@
 
 package com.dmdirc.ui.messages;
 
-import com.dmdirc.events.DisplayProperty;
-import com.dmdirc.events.DisplayableEvent;
-import com.dmdirc.interfaces.EventBus;
-import com.dmdirc.interfaces.WindowModel;
-import com.dmdirc.util.EventUtils;
-
-import java.util.Arrays;
-
-import net.engio.mbassy.listener.Handler;
-
 /**
  * Models the history of a window in the client.
  */
-public class BackBuffer {
-
-    private final IRCDocument document;
-    private final Styliser styliser;
-    private final EventBus eventBus;
-    private final EventFormatter formatter;
-    private final WindowModel owner;
-
-    public BackBuffer(
-            final WindowModel owner,
-            final ColourManagerFactory colourManagerFactory,
-            final EventFormatter formatter) {
-        this.owner = owner;
-        this.styliser = new Styliser(
-                owner.getConnection().orElse(null),
-                owner.getConfigManager(),
-                colourManagerFactory.getColourManager(owner.getConfigManager()));
-        this.document = new IRCDocument(owner.getConfigManager(), styliser);
-        this.eventBus = owner.getEventBus();
-        this.formatter = formatter;
-    }
+public interface BackBuffer {
 
-    /**
-     * Starts adding events received on the event bus to this buffer's document.
-     */
-    public void startAddingEvents() {
-        eventBus.subscribe(this);
-    }
+    Document getDocument();
 
-    /**
-     * Stops adding events received on the event bus to this buffer's document.
-     */
-    public void stopAddingEvents() {
-        eventBus.unsubscribe(this);
-    }
-
-    /**
-     * Handles a displayable event received on the event bus.
-     *
-     * @param event The event to be displayed.
-     */
-    @Handler(priority = EventUtils.PRIORITY_DISPLAYABLE_EVENT_HANDLER)
-    private void handleDisplayableEvent(final DisplayableEvent event) {
-        if (shouldDisplay(event)) {
-            formatter.format(event).map(s -> s.split("\n")).map(Arrays::stream).ifPresent(
-                    t -> t.forEach(line -> document.addText(
-                            event.getTimestamp(), event.getDisplayProperties(), line)));
-        }
-    }
-
-    /**
-     * Determines if the specified event should be displayed in this backbuffer.
-     *
-     * @param event The event to check
-     * @return True if the event should be displayed, false otherwise.
-     */
-    private boolean shouldDisplay(final DisplayableEvent event) {
-        return event.getSource().equals(owner)
-                && !event.hasDisplayProperty(DisplayProperty.DO_NOT_DISPLAY);
-    }
-
-    public IRCDocument getDocument() {
-        return document;
-    }
-
-    public Styliser getStyliser() {
-        return styliser;
-    }
+    Styliser getStyliser();
 
 }
+

src/main/java/com/dmdirc/ui/messages/BackBufferFactory.java

@@ -44,8 +44,8 @@ public class BackBufferFactory {
         this.formatter = formatter;
     }
 
-    public BackBuffer getBackBuffer(final WindowModel owner) {
-        return new BackBuffer(owner, colourManagerFactory, formatter);
+    public BackBufferImpl getBackBuffer(final WindowModel owner) {
+        return new BackBufferImpl(owner, colourManagerFactory, formatter);
     }
 
 }

src/main/java/com/dmdirc/ui/messages/BackBufferImpl.java

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.events.DisplayProperty;
+import com.dmdirc.events.DisplayableEvent;
+import com.dmdirc.interfaces.EventBus;
+import com.dmdirc.interfaces.WindowModel;
+import com.dmdirc.util.EventUtils;
+import java.util.Arrays;
+import net.engio.mbassy.listener.Handler;
+
+/**
+ * Models the history of a window in the client.
+ */
+public class BackBufferImpl implements BackBuffer {
+
+    private final Document document;
+    private final Styliser styliser;
+    private final EventBus eventBus;
+    private final EventFormatter formatter;
+    private final WindowModel owner;
+
+    public BackBufferImpl(
+            final WindowModel owner,
+            final ColourManagerFactory colourManagerFactory,
+            final EventFormatter formatter) {
+        this.owner = owner;
+        this.styliser = new Styliser(
+                owner.getConnection().orElse(null),
+                owner.getConfigManager(),
+                colourManagerFactory.getColourManager(owner.getConfigManager()));
+        this.document = new IRCDocument(owner.getConfigManager(), styliser);
+        this.eventBus = owner.getEventBus();
+        this.formatter = formatter;
+    }
+
+    /**
+     * Starts adding events received on the event bus to this buffer's document.
+     */
+    public void startAddingEvents() {
+        eventBus.subscribe(this);
+    }
+
+    /**
+     * Stops adding events received on the event bus to this buffer's document.
+     */
+    public void stopAddingEvents() {
+        eventBus.unsubscribe(this);
+    }
+
+    /**
+     * Handles a displayable event received on the event bus.
+     *
+     * @param event The event to be displayed.
+     */
+    @Handler(priority = EventUtils.PRIORITY_DISPLAYABLE_EVENT_HANDLER)
+    private void handleDisplayableEvent(final DisplayableEvent event) {
+        if (shouldDisplay(event)) {
+            formatter.format(event).map(s -> s.split("\n")).map(Arrays::stream).ifPresent(
+                    t -> t.forEach(line -> document.addText(
+                            event.getTimestamp(), event.getDisplayProperties(), line)));
+        }
+    }
+
+    /**
+     * Determines if the specified event should be displayed in this backbuffer.
+     *
+     * @param event The event to check
+     * @return True if the event should be displayed, false otherwise.
+     */
+    private boolean shouldDisplay(final DisplayableEvent event) {
+        return event.getSource().equals(owner)
+                && !event.hasDisplayProperty(DisplayProperty.DO_NOT_DISPLAY);
+    }
+
+    @Override
+    public Document getDocument() {
+        return document;
+    }
+
+    @Override
+    public Styliser getStyliser() {
+        return styliser;
+    }
+
+}

src/main/java/com/dmdirc/ui/messages/CachingDocument.java

@@ -31,7 +31,7 @@ import com.dmdirc.util.collections.RollingList;
 public class CachingDocument<T> {
 
     /** The document to wrap and cache data from. */
-    private final IRCDocument document;
+    private final Document document;
     /** The maker to use to produce styled lines. */
     private final StyledMessageMaker<T> maker;
     /** Cached lines. */
@@ -39,7 +39,7 @@ public class CachingDocument<T> {
     /** Cached attributed strings. */
     private final RollingList<T> cachedStrings;
 
-    public CachingDocument(final IRCDocument document, final StyledMessageMaker<T> maker) {
+    public CachingDocument(final Document document, final StyledMessageMaker<T> maker) {
         this.document = document;
         this.maker = maker;
 

src/main/java/com/dmdirc/ui/messages/IRCDocument.java

@@ -38,7 +38,7 @@ import javax.swing.UIManager;
 /**
  * Data contained in a TextPane.
  */
-public class IRCDocument implements Serializable, ConfigChangeListener {
+public class IRCDocument implements Serializable, ConfigChangeListener, Document {
 
     /** A version number for this class. */
     private static final long serialVersionUID = 4;
@@ -73,43 +73,27 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
         setCachedSettings();
     }
 
-    /**
-     * Returns the number of lines in this document.
-     *
-     * @return Number of lines
-     */
+    @Override
     public int getNumLines() {
         synchronized (lines) {
             return lines.size();
         }
     }
 
-    /**
-     * Returns the Line at the specified number.
-     *
-     * @param lineNumber Line number to retrieve
-     *
-     * @return Line at the specified number or null
-     */
+    @Override
     public Line getLine(final int lineNumber) {
         synchronized (lines) {
             return lines.get(lineNumber);
         }
     }
 
-    /**
-     * Adds the stylised string to the canvas.
-     *
-     * @param timestamp The timestamp to show along with the text.
-     * @param displayPropertyMap The display properties to use
-     * @param text stylised string to add to the document
-     */
+    @Override
     public void addText(final LocalDateTime timestamp, final DisplayPropertyMap displayPropertyMap,
-            final String text) {
+        final String text) {
         final int start;
         synchronized (lines) {
             start = lines.size();
-            lines.add(new Line(styliser, formatTimestamp(timestamp), text, displayPropertyMap,
+            lines.add(new IRCLine(styliser, formatTimestamp(timestamp), text, displayPropertyMap,
                     fontSize, fontName));
         }
         fireLinesAdded(start, 1);
@@ -119,11 +103,7 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
         return Formatter.formatMessage(configManager, "timestamp", timestamp);
     }
 
-    /**
-     * Trims the document to the specified number of lines.
-     *
-     * @param numLines Number of lines to trim the document to
-     */
+    @Override
     public void trim(final int numLines) {
         synchronized (lines) {
             if (frameBufferSize != null && frameBufferSize > 0) {
@@ -136,7 +116,7 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
         }
     }
 
-    /** Clears all lines from the document. */
+    @Override
     public void clear() {
         synchronized (lines) {
             lines.clear();
@@ -144,26 +124,18 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
         fireCleared();
     }
 
-    /**
-     * Adds a IRCDocumentListener to the listener list.
-     *
-     * @param listener Listener to add
-     */
-    public void addIRCDocumentListener(final IRCDocumentListener listener) {
+    @Override
+    public void addIRCDocumentListener(final DocumentListener listener) {
         if (listener == null) {
             return;
         }
 
-        listeners.add(IRCDocumentListener.class, listener);
+        listeners.add(DocumentListener.class, listener);
     }
 
-    /**
-     * Removes a IRCDocumentListener from the listener list.
-     *
-     * @param listener Listener to remove
-     */
-    public void removeIRCDocumentListener(final IRCDocumentListener listener) {
-        listeners.remove(IRCDocumentListener.class, listener);
+    @Override
+    public void removeIRCDocumentListener(final DocumentListener listener) {
+        listeners.remove(DocumentListener.class, listener);
     }
 
     /**
@@ -173,8 +145,8 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
      * @param size  Number of lines added
      */
     protected void fireLinesAdded(final int index, final int size) {
-        for (IRCDocumentListener listener
-                : listeners.get(IRCDocumentListener.class)) {
+        for (DocumentListener listener
+                : listeners.get(DocumentListener.class)) {
             listener.linesAdded(index, size, lines.size());
         }
         trim(frameBufferSize);
@@ -187,8 +159,8 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
      * @param trimmedLines Number of trimmed lines
      */
     protected void fireTrimmed(final int newSize, final int trimmedLines) {
-        for (IRCDocumentListener listener
-                : listeners.get(IRCDocumentListener.class)) {
+        for (DocumentListener listener
+                : listeners.get(DocumentListener.class)) {
             listener.trimmed(newSize, trimmedLines);
         }
     }
@@ -197,14 +169,14 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
      * fires the cleared method on all listeners.
      */
     protected void fireCleared() {
-        listeners.get(IRCDocumentListener.class).forEach(IRCDocumentListener::cleared);
+        listeners.get(DocumentListener.class).forEach(DocumentListener::cleared);
     }
 
     /**
      * fires the need repaint method on all listeners.
      */
     protected void fireRepaintNeeded() {
-        listeners.get(IRCDocumentListener.class).forEach(IRCDocumentListener::repaintNeeded);
+        listeners.get(DocumentListener.class).forEach(DocumentListener::repaintNeeded);
     }
 
     /**
@@ -218,13 +190,7 @@ public class IRCDocument implements Serializable, ConfigChangeListener {
         return line.getFontSize();
     }
 
-    /**
-     * Returns the line height of the specified.
-     *
-     * @param line Line
-     *
-     * @return Line height
-     */
+    @Override
     public int getLineHeight(final int line) {
         return getLineHeight(getLine(line));
     }

src/main/java/com/dmdirc/ui/messages/IRCDocumentSearcher.java

@@ -33,7 +33,7 @@ import java.util.regex.Pattern;
 public class IRCDocumentSearcher {
 
     /** Document to search. */
-    private final IRCDocument document;
+    private final Document document;
     /** Phrase to search for. */
     private final String phrase;
     /** Textpane position. */
@@ -48,7 +48,7 @@ public class IRCDocumentSearcher {
      * @param document      Document to search
      * @param caseSensitive Whether or not this searcher is case sensitive
      */
-    public IRCDocumentSearcher(final String phrase, final IRCDocument document,
+    public IRCDocumentSearcher(final String phrase, final Document document,
             final boolean caseSensitive) {
         this.phrase = phrase;
         this.document = document;

src/main/java/com/dmdirc/ui/messages/Line.java → src/main/java/com/dmdirc/ui/messages/IRCLine.java

@@ -24,14 +24,13 @@ package com.dmdirc.ui.messages;
 
 import com.dmdirc.events.DisplayProperty;
 import com.dmdirc.events.DisplayPropertyMap;
-
 import java.util.Arrays;
 import java.util.Optional;
 
 /**
  * Represents a line of text in IRC.
  */
-public class Line {
+public class IRCLine implements Line {
 
     private final String timestamp;
     private final String text;
@@ -50,7 +49,7 @@ public class Line {
      * @param fontSize  The height for this line
      * @param fontName  The name of the font to use for this line
      */
-    public Line(final Styliser styliser, final String timestamp, final String text,
+    public IRCLine(final Styliser styliser, final String timestamp, final String text,
             final DisplayPropertyMap displayProperties, final int fontSize, final String fontName) {
         this.styliser = styliser;
         this.timestamp = timestamp; // TODO: Make this a long and convert further down the line
@@ -65,7 +64,7 @@ public class Line {
      *
      * @return Lines parts
      */
-    public String[] getLineParts() {
+    private String[] getLineParts() {
         if (displayProperties.get(DisplayProperty.NO_TIMESTAMPS).orElse(false)) {
             return new String[] { text };
         } else {
@@ -73,67 +72,37 @@ public class Line {
         }
     }
 
-    /**
-     * Returns the length of the specified line.
-     *
-     * @return Length of the line
-     */
+    @Override
     public int getLength() {
         return timestamp.length() + text.length();
     }
 
-    /**
-     * Returns the height of the specified line.
-     *
-     * @return Line height
-     */
+    @Override
     public int getFontSize() {
         return fontSize;
     }
 
-    /**
-     * Sets the default font size for this line.
-     *
-     * @param fontSize New default font size
-     */
+    @Override
     public void setFontSize(final int fontSize) {
         this.fontSize = fontSize;
     }
 
-    /**
-     * Sets the default font name for this line.
-     *
-     * @param fontName New default font name
-     */
+    @Override
     public void setFontName(final String fontName) {
         this.fontName = fontName;
     }
 
-    /**
-     * Returns the Line text at the specified number.
-     *
-     * @return Line at the specified number or null
-     */
+    @Override
     public String getText() {
         return Styliser.stipControlCodes(timestamp + text);
     }
 
-    /**
-     * Returns the Line text at the specified number.
-     *
-     * @return Line at the specified number or null
-     *
-     * @since 0.6.3m1
-     */
+    @Override
     public String getStyledText() {
         return timestamp + text;
     }
 
-    /**
-     * Converts a StyledDocument into an AttributedString.
-     *
-     * @return AttributedString representing the specified StyledDocument
-     */
+    @Override
     public <T> T getStyled(final StyledMessageMaker<T> maker) {
         maker.setDefaultFont(fontName, fontSize);
         final T styledString = styliser.getStyledString(getLineParts(), maker);
@@ -144,7 +113,7 @@ public class Line {
 
     @Override
     public boolean equals(final Object obj) {
-        return obj instanceof Line && Arrays.equals(((Line) obj).getLineParts(), getLineParts());
+        return obj instanceof Line && Arrays.equals(((IRCLine) obj).getLineParts(), getLineParts());
     }
 
     @Override
@@ -152,6 +121,7 @@ public class Line {
         return Arrays.hashCode(getLineParts());
     }
 
+    @Override
     public <T> Optional<T> getDisplayableProperty(final DisplayProperty<T> property) {
         return displayProperties.get(property);
     }