Merge pull request #712 from csmith/master

Move IRC control codes to their own class.

src/main/java/com/dmdirc/commandparser/commands/Command.java

 import com.dmdirc.events.CommandOutputEvent;
 import com.dmdirc.interfaces.CommandController;
 import com.dmdirc.interfaces.WindowModel;
-import com.dmdirc.ui.messages.Styliser;
+import com.dmdirc.ui.messages.IRCControlCodes;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
      */
     protected static String doTable(final String[] headers, final String[][] data) {
         final StringBuilder res = new StringBuilder();
-        res.append(Styliser.CODE_FIXED);
-        res.append(Styliser.CODE_BOLD);
+        res.append(IRCControlCodes.FIXED);
+        res.append(IRCControlCodes.BOLD);
 
         final int[] maxsizes = new int[headers.length];
 
 
         for (String[] source : data) {
             res.append('\n');
-            res.append(Styliser.CODE_FIXED);
+            res.append(IRCControlCodes.FIXED);
 
             for (int i = 0; i < source.length; i++) {
                 doPadding(res, source[i], maxsizes[i]);

src/main/java/com/dmdirc/commandparser/commands/global/Help.java

 import com.dmdirc.interfaces.WindowModel;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.input.TabCompletionType;
-import com.dmdirc.ui.messages.Styliser;
+import com.dmdirc.ui.messages.IRCControlCodes;
 
 import java.util.ArrayList;
 import java.util.Collections;
 
         Collections.sort(commands);
 
-        showOutput(origin, isSilent, Styliser.CODE_FIXED
+        showOutput(origin, isSilent, IRCControlCodes.FIXED
                 + "----------------------- Available commands -------");
 
         final StringBuilder builder = new StringBuilder();
 
         for (String command : commands) {
             if (builder.length() + command.length() + 1 > 50) {
-                showOutput(origin, isSilent, Styliser.CODE_FIXED + builder.toString());
+                showOutput(origin, isSilent, IRCControlCodes.FIXED + builder.toString());
                 builder.delete(0, builder.length());
             } else if (builder.length() > 0) {
                 builder.append(' ');
         }
 
         if (builder.length() > 0) {
-            showOutput(origin, isSilent, Styliser.CODE_FIXED + builder.toString());
+            showOutput(origin, isSilent, IRCControlCodes.FIXED + builder.toString());
         }
 
-        showOutput(origin, isSilent, Styliser.CODE_FIXED
+        showOutput(origin, isSilent, IRCControlCodes.FIXED
                 + "--------------------------------------------------");
     }
 
         if (command == null) {
             showError(origin, isSilent, "Command '" + name + "' not found.");
         } else {
-            showOutput(origin, isSilent, Styliser.CODE_FIXED
+            showOutput(origin, isSilent, IRCControlCodes.FIXED
                     + "---------------------- Command information -------");
-            showOutput(origin, isSilent, Styliser.CODE_FIXED
+            showOutput(origin, isSilent, IRCControlCodes.FIXED
                     + " Name: " + name);
-            showOutput(origin, isSilent, Styliser.CODE_FIXED
+            showOutput(origin, isSilent, IRCControlCodes.FIXED
                     + " Type: " + command.getKey().getType());
-            showOutput(origin, isSilent, Styliser.CODE_FIXED
+            showOutput(origin, isSilent, IRCControlCodes.FIXED
                     + "Usage: " + command.getKey().getHelp());
-            showOutput(origin, isSilent, Styliser.CODE_FIXED
+            showOutput(origin, isSilent, IRCControlCodes.FIXED
                     + "--------------------------------------------------");
         }
     }

src/main/java/com/dmdirc/commandparser/commands/server/OpenQuery.java

 import com.dmdirc.interfaces.WindowModel;
 import com.dmdirc.ui.input.AdditionalTabTargets;
 import com.dmdirc.ui.input.TabCompletionType;
-import com.dmdirc.ui.messages.Styliser;
+import com.dmdirc.ui.messages.IRCControlCodes;
 
 import javax.annotation.Nonnull;
 import javax.inject.Inject;
         final Connection connection = ((ServerCommandContext) context).getConnection();
         if (connection.getParser().get().isValidChannelName(args.getArguments()[0])) {
             showError(origin, args.isSilent(), "You can't open a query "
-                    + "with a channel; maybe you meant " + Styliser.CODE_FIXED
-                    + Styliser.CODE_BOLD
+                    + "with a channel; maybe you meant " + IRCControlCodes.FIXED
+                    + IRCControlCodes.BOLD
                     + getController().getCommandChar()
                     + (args.getArguments().length > 1 ? "msg" : "join") + ' '
                     + args.getArgumentsAsString()
-                    + Styliser.CODE_BOLD + Styliser.CODE_FIXED + '?');
+                    + IRCControlCodes.BOLD + IRCControlCodes.FIXED + '?');
             return;
         }
 

src/main/java/com/dmdirc/ui/input/InputHandler.java

 import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.input.tabstyles.TabCompletionResult;
 import com.dmdirc.ui.input.tabstyles.TabCompletionStyle;
-import com.dmdirc.ui.messages.Styliser;
+import com.dmdirc.ui.messages.IRCControlCodes;
 import com.dmdirc.util.collections.ListenerList;
 import com.dmdirc.util.collections.RollingList;
 import com.dmdirc.util.validators.ValidationResponse;
             // or control code with a comma (so they can pick a background)
             final String partialLine = line.substring(0, caretPosition - 1);
 
-            if (partialLine.matches("^.*" + Styliser.CODE_COLOUR + "[0-9]{0,2}$")) {
+            if (partialLine.matches("^.*" + IRCControlCodes.COLOUR + "[0-9]{0,2}$")) {
                 target.showColourPicker(true, false);
-            } else if (partialLine.matches("^.*" + Styliser.CODE_HEXCOLOUR + "[0-9A-Z]{6}?$")) {
+            } else if (partialLine.matches("^.*" + IRCControlCodes.COLOUR_HEX + "[0-9A-Z]{6}?$")) {
                 target.showColourPicker(false, true);
             }
         }
             final boolean shiftPressed) {
         switch (keyCode) {
             case KeyEvent.VK_B:
-                addControlCode(Styliser.CODE_BOLD, POSITION_END);
+                addControlCode(IRCControlCodes.BOLD, POSITION_END);
                 break;
 
             case KeyEvent.VK_U:
-                addControlCode(Styliser.CODE_UNDERLINE, POSITION_END);
+                addControlCode(IRCControlCodes.UNDERLINE, POSITION_END);
                 break;
 
             case KeyEvent.VK_O:
-                addControlCode(Styliser.CODE_STOP, POSITION_END);
+                addControlCode(IRCControlCodes.STOP, POSITION_END);
                 break;
 
             case KeyEvent.VK_I:
-                addControlCode(Styliser.CODE_ITALIC, POSITION_END);
+                addControlCode(IRCControlCodes.ITALIC, POSITION_END);
                 break;
 
             case KeyEvent.VK_F:
                 if (shiftPressed) {
-                    addControlCode(Styliser.CODE_FIXED, POSITION_END);
+                    addControlCode(IRCControlCodes.FIXED, POSITION_END);
                 }
                 break;
 
             case KeyEvent.VK_K:
                 if (shiftPressed) {
-                    addControlCode(Styliser.CODE_HEXCOLOUR, POSITION_START);
+                    addControlCode(IRCControlCodes.COLOUR_HEX, POSITION_START);
                     target.showColourPicker(false, true);
                 } else {
-                    addControlCode(Styliser.CODE_COLOUR, POSITION_START);
+                    addControlCode(IRCControlCodes.COLOUR, POSITION_START);
                     target.showColourPicker(true, false);
                 }
                 break;

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

+/*
+ * Copyright (c) 2006-2016 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;
+
+/**
+ * Contains constants for IRC 'control codes' that modify text styles.
+ */
+public interface IRCControlCodes {
+
+  /** The character used for marking up bold text. */
+  char BOLD = 2;
+  /** The character used for marking up coloured text. */
+  char COLOUR = 3;
+  /** The character used for marking up coloured text (using hex). */
+  char COLOUR_HEX = 4;
+  /** The character used for stopping all formatting. */
+  char STOP = 15;
+  /** The character used for marking up fixed pitch text. */
+  char FIXED = 17;
+  /** The character used for negating control codes. */
+  char NEGATE = 18;
+  /** The character used for marking up italic text. */
+  char ITALIC = 29;
+  /** The character used for marking up underlined text. */
+  char UNDERLINE = 31;
+
+}

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

     @Override
     public <T> T getStyled(final StyledMessageMaker<T> maker) {
         maker.setDefaultFont(fontName, fontSize);
-        final T styledString = styliser.getStyledString(getLineParts(), maker);
+        styliser.addStyledString(maker, getLineParts());;
+        final T styledString = maker.getStyledMessage();
         fontSize = maker.getMaximumFontSize();
         maker.clear();
         return styledString;

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

 
 package com.dmdirc.ui.messages;
 
+import static com.google.common.base.Preconditions.checkArgument;
+
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.ConfigChangeListener;
 import com.dmdirc.util.colours.Colour;
-
 import java.util.Locale;
 import java.util.regex.Pattern;
-
 import javax.annotation.Nullable;
 
-import static com.google.common.base.Preconditions.checkArgument;
-
 /**
  * The styliser applies IRC styles to text. Styles are indicated by various control codes which are
  * a de-facto IRC standard.
  */
 public class Styliser implements ConfigChangeListener {
 
-    /** The character used for marking up bold text. */
-    public static final char CODE_BOLD = 2;
-    /** The character used for marking up coloured text. */
-    public static final char CODE_COLOUR = 3;
-    /** The character used for marking up coloured text (using hex). */
-    public static final char CODE_HEXCOLOUR = 4;
     /** Character used to indicate hyperlinks. */
     public static final char CODE_HYPERLINK = 5;
     /** Character used to indicate channel links. */
     public static final char CODE_CHANNEL = 6;
     /** Character used to indicate smilies. */
     public static final char CODE_SMILIE = 7;
-    /** The character used for stopping all formatting. */
-    public static final char CODE_STOP = 15;
     /** Character used to indicate nickname links. */
     public static final char CODE_NICKNAME = 16;
-    /** The character used for marking up fixed pitch text. */
-    public static final char CODE_FIXED = 17;
-    /** The character used for negating control codes. */
-    public static final char CODE_NEGATE = 18;
     /** The character used for tooltips. */
     public static final char CODE_TOOLTIP = 19;
-    /** The character used for marking up italic text. */
-    public static final char CODE_ITALIC = 29;
-    /** The character used for marking up underlined text. */
-    public static final char CODE_UNDERLINE = 31;
     /** Internal chars. */
     private static final String INTERNAL_CHARS = String.valueOf(CODE_HYPERLINK)
             + CODE_NICKNAME + CODE_CHANNEL + CODE_SMILIE + CODE_TOOLTIP;
     /** Characters used for hyperlinks. */
     private static final String HYPERLINK_CHARS = Character.toString(CODE_HYPERLINK) + CODE_CHANNEL;
     /** Regexp to match characters which shouldn't be used in channel links. */
-    private static final String RESERVED_CHARS = "[^\\s" + CODE_BOLD + CODE_COLOUR
-            + CODE_STOP + CODE_HEXCOLOUR + CODE_FIXED + CODE_ITALIC
-            + CODE_UNDERLINE + CODE_CHANNEL + CODE_NICKNAME + CODE_NEGATE + "\",]";
+    private static final String RESERVED_CHARS = "[^\\s" + IRCControlCodes.BOLD + IRCControlCodes.COLOUR
+            + IRCControlCodes.STOP + IRCControlCodes.COLOUR_HEX + IRCControlCodes.FIXED + IRCControlCodes.ITALIC
+            + IRCControlCodes.UNDERLINE + CODE_CHANNEL + CODE_NICKNAME + IRCControlCodes.NEGATE
+        + "\",]";
     /** Defines all characters treated as trailing punctuation that are illegal in URLs. */
     private static final String URL_PUNCT_ILLEGAL = "\"";
     /** Defines all characters treated as trailing punctuation that're legal in URLs. */
     private static final String URL_CHARS = '[' + URL_PUNCT_LEGAL + URL_NOPUNCT
             + "]*[" + URL_NOPUNCT + "]+[" + URL_PUNCT_LEGAL + URL_NOPUNCT + "]*";
     /** The regular expression to use for marking up URLs. */
-    private static final String URL_REGEXP = "(?i)((?>(?<!" + CODE_HEXCOLOUR
+    private static final String URL_REGEXP = "(?i)((?>(?<!" + IRCControlCodes.COLOUR_HEX
             + "[a-f0-9]{5})[a-f]|[g-z+])+://" + URL_CHARS
             + "|(?<![a-z0-9:/])www\\." + URL_CHARS + ')';
     /** Regular expression for intelligent handling of closing brackets. */
         }
     }
 
-    /**
-     * Stylises the specified string.
-     *
-     * @param strings The line to be stylised
-     *
-     * @return StyledDocument for the inputted strings
-     */
-    public <T> T getStyledString(final String[] strings, final StyledMessageMaker<T> maker) {
-        addStyledString(maker, strings);
-        return maker.getStyledMessage();
-    }
-
     /**
      * Retrieves the styled String contained within the unstyled offsets specified. That is, the
      * <code>from</code> and <code>to</code> arguments correspond to indexes in an unstyled version
      *
      * @since 0.6.3m1
      */
-    public String doSmilies(final String string) {
+    private String doSmilies(final String string) {
         // TODO: Check if they're enabled.
         // TODO: Store the list instead of building it every line
 
      * @return a copy of the input with control codes removed
      */
     public static String stipControlCodes(final String input) {
-        return input.replaceAll("[" + CODE_BOLD + CODE_CHANNEL + CODE_FIXED
-                + CODE_HYPERLINK + CODE_ITALIC + CODE_NEGATE + CODE_NICKNAME
-                + CODE_SMILIE + CODE_STOP + CODE_UNDERLINE + "]|"
-                + CODE_HEXCOLOUR + "([A-Za-z0-9]{6}(,[A-Za-z0-9]{6})?)?|"
-                + CODE_COLOUR + "([0-9]{1,2}(,[0-9]{1,2})?)?", "")
+        return input.replaceAll("[" + IRCControlCodes.BOLD + CODE_CHANNEL + IRCControlCodes.FIXED
+                + CODE_HYPERLINK + IRCControlCodes.ITALIC + IRCControlCodes.NEGATE + CODE_NICKNAME
+                + CODE_SMILIE + IRCControlCodes.STOP + IRCControlCodes.UNDERLINE + "]|"
+                + IRCControlCodes.COLOUR_HEX + "([A-Za-z0-9]{6}(,[A-Za-z0-9]{6})?)?|"
+                + IRCControlCodes.COLOUR + "([0-9]{1,2}(,[0-9]{1,2})?)?", "")
                 .replaceAll(CODE_TOOLTIP + ".*?" + CODE_TOOLTIP + "(.*?)" + CODE_TOOLTIP, "$1");
     }
 
      *
      * @since 0.6.5
      */
-    public static String stipInternalControlCodes(final String input) {
+    private static String stipInternalControlCodes(final String input) {
         return input.replaceAll("[" + CODE_CHANNEL + CODE_HYPERLINK + CODE_NICKNAME
-                + CODE_SMILIE + CODE_STOP + CODE_UNDERLINE + ']', "")
+                + CODE_SMILIE + IRCControlCodes.STOP + IRCControlCodes.UNDERLINE + ']', "")
                 .replaceAll(CODE_TOOLTIP + ".*?" + CODE_TOOLTIP + "(.*?)"
                         + CODE_TOOLTIP, "$1");
     }
     public static String readUntilControl(final String input) {
         int pos = input.length();
 
-        pos = checkChar(pos, input.indexOf(CODE_BOLD));
-        pos = checkChar(pos, input.indexOf(CODE_UNDERLINE));
-        pos = checkChar(pos, input.indexOf(CODE_STOP));
-        pos = checkChar(pos, input.indexOf(CODE_COLOUR));
-        pos = checkChar(pos, input.indexOf(CODE_HEXCOLOUR));
-        pos = checkChar(pos, input.indexOf(CODE_ITALIC));
-        pos = checkChar(pos, input.indexOf(CODE_FIXED));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.BOLD));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.UNDERLINE));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.STOP));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.COLOUR));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.COLOUR_HEX));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.ITALIC));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.FIXED));
         pos = checkChar(pos, input.indexOf(CODE_HYPERLINK));
         pos = checkChar(pos, input.indexOf(CODE_NICKNAME));
         pos = checkChar(pos, input.indexOf(CODE_CHANNEL));
         pos = checkChar(pos, input.indexOf(CODE_SMILIE));
-        pos = checkChar(pos, input.indexOf(CODE_NEGATE));
+        pos = checkChar(pos, input.indexOf(IRCControlCodes.NEGATE));
         pos = checkChar(pos, input.indexOf(CODE_TOOLTIP));
 
         return input.substring(0, pos);
         final boolean isNegated = state.isNegated;
 
         // Bold
-        if (string.charAt(0) == CODE_BOLD) {
+        if (string.charAt(0) == IRCControlCodes.BOLD) {
             if (!isNegated) {
                 maker.toggleBold();
             }
         }
 
         // Underline
-        if (string.charAt(0) == CODE_UNDERLINE) {
+        if (string.charAt(0) == IRCControlCodes.UNDERLINE) {
             if (!isNegated) {
                 maker.toggleUnderline();
             }
         }
 
         // Italic
-        if (string.charAt(0) == CODE_ITALIC) {
+        if (string.charAt(0) == IRCControlCodes.ITALIC) {
             if (!isNegated) {
                 maker.toggleItalic();
             }
         }
 
         // Fixed pitch
-        if (string.charAt(0) == CODE_FIXED) {
+        if (string.charAt(0) == IRCControlCodes.FIXED) {
             if (!isNegated) {
                 maker.toggleFixedWidth();
             }
         }
 
         // Stop formatting
-        if (string.charAt(0) == CODE_STOP) {
+        if (string.charAt(0) == IRCControlCodes.STOP) {
             if (!isNegated) {
                 maker.resetAllStyles();
             }
         }
 
         // Colours
-        if (string.charAt(0) == CODE_COLOUR) {
+        if (string.charAt(0) == IRCControlCodes.COLOUR) {
             int count = 1;
             // This isn't too nice!
             if (string.length() > count && isInt(string.charAt(count))) {
         }
 
         // Hex colours
-        if (string.charAt(0) == CODE_HEXCOLOUR) {
+        if (string.charAt(0) == IRCControlCodes.COLOUR_HEX) {
             int count = 1;
             if (hasHexString(string, 1)) {
                 if (!isNegated) {
         }
 
         // Control code negation
-        if (string.charAt(0) == CODE_NEGATE) {
+        if (string.charAt(0) == IRCControlCodes.NEGATE) {
             state.isNegated = !state.isNegated;
             return 1;
         }
 
     private static class StyliserState {
 
-        public boolean isNegated;
-        public boolean isInLink;
-        public boolean isInSmilie;
-        public boolean isInToolTip;
+        boolean isNegated;
+        boolean isInLink;
+        boolean isInSmilie;
+        boolean isInToolTip;
 
     }
 

src/test/java/com/dmdirc/ui/messages/StyliserIndicesTest.java

             // No style
             {"Blah blah blah", 0, 1, "B"},
             {"Blah blah blah", 0, 4, "Blah"},
-            {Styliser.CODE_BOLD + "Blah blah blah", 0, 4, Styliser.CODE_BOLD + "Blah"},
-            {Styliser.CODE_BOLD + "Bl" + Styliser.CODE_BOLD + "ah blah blah",
-                     0, 4, Styliser.CODE_BOLD + "Bl" + Styliser.CODE_BOLD + "ah"},
-            {"Blah" + Styliser.CODE_BOLD + " blah blah",
+            {IRCControlCodes.BOLD + "Blah blah blah", 0, 4, IRCControlCodes.BOLD + "Blah"},
+            {IRCControlCodes.BOLD + "Bl" + IRCControlCodes.BOLD + "ah blah blah",
+                     0, 4, IRCControlCodes.BOLD + "Bl" + IRCControlCodes.BOLD + "ah"},
+            {"Blah" + IRCControlCodes.BOLD + " blah blah",
                      0, 4, "Blah"},
-            {"Blah" + Styliser.CODE_COLOUR + "4,0RED blah blah",
-                     4, 7, Styliser.CODE_COLOUR + "4,0RED"},
-            {"Blah" + Styliser.CODE_COLOUR + "4,0RED blah blah",
+            {"Blah" + IRCControlCodes.COLOUR + "4,0RED blah blah",
+                     4, 7, IRCControlCodes.COLOUR + "4,0RED"},
+            {"Blah" + IRCControlCodes.COLOUR + "4,0RED blah blah",
                      5, 7, "ED"},
             {Styliser.CODE_TOOLTIP + "Annoying internal tooltip text"
                      + Styliser.CODE_TOOLTIP + "Blah" + Styliser.CODE_TOOLTIP + "Blah",