Add a way to specify event colours.

res/com/dmdirc/ui/messages/format.yml

@@ -1,9 +1,22 @@
 ---
-ChannelModeNoticeEvent: "-{{client}}:{{prefix}}{{channel.name}}- {{message}}"
-ChannelNoticeEvent: "-{{client}}:{{channel.name}}- {{message}}"
-ChannelMessageEvent: "<{{client}}> {{message}}"
-ChannelActionEvent: "* {{client}} {{message}}"
-ChannelSelfMessageEvent: "<{{client}}> {{message}}"
-ChannelSelfActionEvent: "* {{client}} {{message}}"
-ChannelSelfExternalMessageEvent: "<{{client}}> {{message}}"
-ChannelSelfExternalActionEvent: "* {{client}} {{message}}"
+ChannelModeNoticeEvent:
+  format: "-{{client}}:{{prefix}}{{channel.name}}- {{message}}"
+  colour: 5
+ChannelNoticeEvent:
+  format: "-{{client}}:{{channel.name}}- {{message}}"
+  colour: 5
+ChannelMessageEvent:
+  format: "<{{client}}> {{message}}"
+ChannelActionEvent:
+  format: "* {{client}} {{message}}"
+  colour: 6
+ChannelSelfMessageEvent:
+  format: "<{{client}}> {{message}}"
+ChannelSelfActionEvent:
+  format: "* {{client}} {{message}}"
+  colour: 6
+ChannelSelfExternalMessageEvent:
+  format: "<{{client}}> {{message}}"
+ChannelSelfExternalActionEvent:
+  format: "* {{client}} {{message}}"
+  colour: 6

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

@@ -26,11 +26,6 @@ import com.dmdirc.DMDircMBassador;
 import com.dmdirc.FrameContainer;
 import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
-import com.dmdirc.ui.messages.ColourManagerFactory;
-import com.dmdirc.ui.messages.EventFormatter;
-import com.dmdirc.ui.messages.Formatter;
-import com.dmdirc.ui.messages.IRCDocument;
-import com.dmdirc.ui.messages.Styliser;
 
 import java.util.Date;
 

src/com/dmdirc/ui/messages/EventFormat.java

@@ -0,0 +1,48 @@
+/*
+ * 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.ui.messages;
+
+import com.dmdirc.util.colours.Colour;
+
+import com.google.auto.value.AutoValue;
+
+import java.util.Optional;
+
+/**
+ * Describes a format for an event.
+ */
+@AutoValue
+public abstract class EventFormat {
+
+    public abstract String getTemplate();
+
+    // TODO: This should probably be a generic set of properties.
+    public abstract Optional<Colour> getDefaultForegroundColour();
+
+    public static EventFormat create(
+            final String template,
+            final Optional<Colour> defaultForegroundColour) {
+        return new AutoValue_EventFormat(template, defaultForegroundColour);
+    }
+
+}

src/com/dmdirc/ui/messages/EventTemplateProvider.java → src/com/dmdirc/ui/messages/EventFormatProvider.java

@@ -27,16 +27,16 @@ import com.dmdirc.events.DisplayableEvent;
 import java.util.Optional;
 
 /**
- * Provides templates to be used for displayable events.
+ * Provides formats to be used for displayable events.
  */
-public interface EventTemplateProvider {
+public interface EventFormatProvider {
 
     /**
-     * Gets the template to be used, if any, for the given event type.
+     * Gets the format to be used, if any, for the given event type.
      *
-     * @param eventType The type of event to retrieve a template for.
-     * @return The template to use, or an absent optional if no template is defined.
+     * @param eventType The type of event to retrieve a format for.
+     * @return The format to use, or an absent optional if no format is defined.
      */
-    Optional<String> getTemplate(final Class<? extends DisplayableEvent> eventType);
+    Optional<EventFormat> getFormat(final Class<? extends DisplayableEvent> eventType);
 
 }

src/com/dmdirc/ui/messages/EventFormatter.java

@@ -47,20 +47,20 @@ public class EventFormatter {
     private static final String ERROR_STRING = "<FormatError>";
 
     private final EventPropertyManager propertyManager;
-    private final EventTemplateProvider templateProvider;
+    private final EventFormatProvider formatProvider;
 
     @Inject
     public EventFormatter(final EventPropertyManager propertyManager,
-            final EventTemplateProvider templateProvider) {
+            final EventFormatProvider formatProvider) {
         this.propertyManager = propertyManager;
-        this.templateProvider = templateProvider;
+        this.formatProvider = formatProvider;
     }
 
     public Optional<String> format(final DisplayableEvent event) {
-        final Optional<String> template = templateProvider.getTemplate(event.getClass());
+        final Optional<EventFormat> template = formatProvider.getFormat(event.getClass());
 
         if (template.isPresent()) {
-            final StringBuilder builder = new StringBuilder(template.get());
+            final StringBuilder builder = new StringBuilder(template.get().getTemplate());
             int tagStart = builder.indexOf("{{");
             while (tagStart > -1) {
                 final int tagEnd = builder.indexOf("}}", tagStart);
@@ -68,7 +68,7 @@ public class EventFormatter {
                 builder.replace(tagStart, tagEnd + 2, getReplacement(event, tag));
                 tagStart = builder.indexOf("{{");
             }
-            return Optional.ofNullable(builder.toString());
+            return Optional.of(builder.toString());
         }
 
         return Optional.empty();

src/com/dmdirc/ui/messages/UiMessagesModule.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.ui.messages;
 
+import com.dmdirc.ClientModule.GlobalConfig;
 import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
 
@@ -42,10 +43,13 @@ public class UiMessagesModule {
 
     @Provides
     @Singleton
-    public EventTemplateProvider getTemplateProvider(@Directory(BASE) final Path directory,
+    public EventFormatProvider getTemplateProvider(
+            @Directory(BASE) final Path directory,
+            @GlobalConfig final ColourManager colourManager,
             final DMDircMBassador eventBus) {
-        final YamlEventTemplateProvider provider =
-                new YamlEventTemplateProvider(directory.resolve("format.yml"), eventBus);
+        final YamlEventFormatProvider provider =
+                new YamlEventFormatProvider(directory.resolve("format.yml"), eventBus,
+                        colourManager);
         provider.load();
         return provider;
     }

src/com/dmdirc/ui/messages/YamlEventTemplateProvider.java → src/com/dmdirc/ui/messages/YamlEventFormatProvider.java

@@ -26,6 +26,7 @@ import com.dmdirc.DMDircMBassador;
 import com.dmdirc.events.AppErrorEvent;
 import com.dmdirc.events.DisplayableEvent;
 import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.util.colours.Colour;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -41,20 +42,23 @@ import com.esotericsoftware.yamlbeans.YamlReader;
 import static com.dmdirc.util.YamlReaderUtils.asMap;
 
 /**
- * YAML-backed supplier of event templates.
+ * YAML-backed supplier of event formats.
  */
-public class YamlEventTemplateProvider implements EventTemplateProvider {
+public class YamlEventFormatProvider implements EventFormatProvider {
 
     /** The charset to use when reading and writing files. */
     private static final String CHARSET = "UTF-8";
 
     private final Path path;
     private final DMDircMBassador eventBus;
-    private final Map<String, String> formats = new HashMap<>();
+    private final ColourManager colourManager;
+    private final Map<String, EventFormat> formats = new HashMap<>();
 
-    public YamlEventTemplateProvider(final Path path, final DMDircMBassador eventBus) {
+    public YamlEventFormatProvider(final Path path, final DMDircMBassador eventBus,
+            final ColourManager colourManager) {
         this.path = path;
         this.eventBus = eventBus;
+        this.colourManager = colourManager;
     }
 
     public void load() {
@@ -82,7 +86,7 @@ public class YamlEventTemplateProvider implements EventTemplateProvider {
             final YamlReader yamlReader = new YamlReader(reader);
             final Object root = yamlReader.read();
             final Map<Object, Object> entries = asMap(root);
-            entries.forEach((k, v) -> formats.put(k.toString(), v.toString()));
+            entries.forEach((k, v) -> formats.put(k.toString(), readFormat(v)));
             yamlReader.close();
         } catch (IOException e) {
             eventBus.publishAsync(new AppErrorEvent(ErrorLevel.LOW, e,
@@ -90,8 +94,18 @@ public class YamlEventTemplateProvider implements EventTemplateProvider {
         }
     }
 
+    private EventFormat readFormat(final Object format) {
+        final Map<Object, Object> info = asMap(format);
+        final String template = info.get("format").toString();
+        final Optional<Colour> foregroundColour = info.containsKey("colour")
+                ? Optional.of(colourManager.getColourFromIrcCode(
+                        Integer.parseInt(info.get("colour").toString())))
+                : Optional.empty();
+        return EventFormat.create(template, foregroundColour);
+    }
+
     @Override
-    public Optional<String> getTemplate(final Class<? extends DisplayableEvent> eventType) {
+    public Optional<EventFormat> getFormat(final Class<? extends DisplayableEvent> eventType) {
         return Optional.ofNullable(formats.get(eventType.getSimpleName()));
     }
 

test/com/dmdirc/ui/messages/EventFormatterTest.java

@@ -40,7 +40,7 @@ import static org.mockito.Mockito.when;
 public class EventFormatterTest {
 
     @Mock private EventPropertyManager propertyManager;
-    @Mock private EventTemplateProvider templateProvider;
+    @Mock private EventFormatProvider templateProvider;
     @Mock private Channel channel;
     private ChannelMessageEvent messageEvent;
     private EventFormatter formatter;
@@ -54,8 +54,9 @@ public class EventFormatterTest {
     public void testBasicFormat() {
         messageEvent = new ChannelMessageEvent(channel, null, null);
 
-        when(templateProvider.getTemplate(ChannelMessageEvent.class))
-                .thenReturn(Optional.ofNullable("Template {{channel}} meep"));
+        when(templateProvider.getFormat(ChannelMessageEvent.class))
+                .thenReturn(Optional.ofNullable(
+                        EventFormat.create("Template {{channel}} meep", Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
                 .thenReturn(Optional.of("MONKEY"));
 
@@ -66,8 +67,10 @@ public class EventFormatterTest {
     public void testFormatWithFunction() {
         messageEvent = new ChannelMessageEvent(channel, null, null);
 
-        when(templateProvider.getTemplate(ChannelMessageEvent.class))
-                .thenReturn(Optional.ofNullable("Template {{channel|lowercase}} meep"));
+        when(templateProvider.getFormat(ChannelMessageEvent.class))
+                .thenReturn(Optional.ofNullable(
+                        EventFormat.create("Template {{channel|lowercase}} meep",
+                                Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
                 .thenReturn(Optional.of("MONKEY"));
         when(propertyManager.applyFunction("MONKEY", "lowercase")).thenReturn("monkey");