Add concept of Displayable events.

These are events which are going to cause a line to be added to a
client window. They allow actions, plugins, or other listeners
to change the formatter line.

Eventually the UI model will just be able to listen for displayable
events on the local event bus to figure out what needs to be displayed.

Change-Id: Ia86c593df66f8bff13574714c45464a2634c02ba
Reviewed-on: http://gerrit.dmdirc.com/3390
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/ChannelEventHandler.java

@@ -26,6 +26,7 @@ import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.events.ChannelUserAwayEvent;
 import com.dmdirc.events.ChannelUserBackEvent;
+import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.actions.ActionType;
 import com.dmdirc.parser.common.AwayState;
@@ -315,14 +316,14 @@ public class ChannelEventHandler extends EventHandler implements
             final boolean away = state == AwayState.AWAY;
             final boolean discovered = oldState == AwayState.UNKNOWN;
 
-            // TODO: The events should take a formatter.
-            owner.doNotification(date, (away ? "channelUserAway" : "channelUserBack")
-                    + (discovered ? "Discovered" : ""), channelClient);
-            if (away) {
-                eventBus.post(new ChannelUserAwayEvent(owner, channelClient));
-            } else {
-                eventBus.post(new ChannelUserBackEvent(owner, channelClient));
-            }
+            final DisplayableEvent event = away
+                    ? new ChannelUserAwayEvent(date.getTime(), owner, channelClient)
+                    : new ChannelUserBackEvent(date.getTime(), owner, channelClient);
+            event.setDisplayFormat((away ? "channelUserAway" : "channelUserBack")
+                    + (discovered ? "Discovered" : ""));
+            eventBus.post(event);
+            owner.doNotification(date, event.getDisplayFormat(), channelClient);
+
         }
     }
 

src/com/dmdirc/actions/ActionManager.java

@@ -28,6 +28,7 @@ import com.dmdirc.actions.internal.WhoisNumericFormatter;
 import com.dmdirc.config.ConfigBinding;
 import com.dmdirc.events.ClientClosedEvent;
 import com.dmdirc.events.DMDircEvent;
+import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.interfaces.ActionController;
 import com.dmdirc.interfaces.ActionListener;
 import com.dmdirc.interfaces.actions.ActionComparison;
@@ -457,7 +458,18 @@ public class ActionManager implements ActionController {
         final Class[] argTypes = type.getType().getArgTypes();
         final Object[] arguments = getLegacyArguments(event, argTypes);
 
-        triggerEvent(type, null, arguments);
+        final StringBuffer buffer;
+        if (event instanceof DisplayableEvent) {
+            buffer = new StringBuffer(((DisplayableEvent) event).getDisplayFormat());
+        } else {
+            buffer = null;
+        }
+
+        triggerEvent(type, buffer, arguments);
+
+        if (event instanceof DisplayableEvent) {
+            ((DisplayableEvent) event).setDisplayFormat(buffer.toString());
+        }
     }
 
     /**

src/com/dmdirc/events/ChannelEvent.java

@@ -24,15 +24,19 @@ package com.dmdirc.events;
 
 import com.dmdirc.Channel;
 
+import java.util.concurrent.atomic.AtomicReference;
+
 import static com.google.common.base.Preconditions.checkNotNull;
 
 /**
  * Base type for events that occur in channels.
  */
-public abstract class ChannelEvent extends DMDircEvent {
+public abstract class ChannelEvent extends DMDircEvent implements DisplayableEvent {
 
     /** The channel that this event occurred on. */
     private final Channel channel;
+    /** The display format to use for this event. */
+    private final AtomicReference<String> displayFormatRef = new AtomicReference<>("");
 
     public ChannelEvent(final long timestamp, final Channel channel) {
         super(timestamp);
@@ -47,4 +51,14 @@ public abstract class ChannelEvent extends DMDircEvent {
         return channel;
     }
 
+    @Override
+    public String getDisplayFormat() {
+        return displayFormatRef.get();
+    }
+
+    @Override
+    public void setDisplayFormat(String format) {
+        this.displayFormatRef.set(format);
+    }
+
 }

src/com/dmdirc/events/DisplayableEvent.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2006-2014 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.events;
+
+/**
+ * Describes an event which is rendered in the client to the user.
+ */
+public interface DisplayableEvent {
+
+    /**
+     * Gets the format name that will be used to display the event.
+     *
+     * @return The format name to use for the event.
+     */
+    String getDisplayFormat();
+
+    /**
+     * Sets the format name that should be used to display the event.
+     *
+     * @param format The format name to use for the event.
+     */
+    void setDisplayFormat(String format);
+
+}