Merge branch 'master' of https://github.com/DMDirc/DMDirc

src/main/java/com/dmdirc/commandparser/CommandArguments.java → api/src/main/java/com/dmdirc/commandparser/CommandArguments.java

@@ -22,7 +22,6 @@
 
 package com.dmdirc.commandparser;
 
-import com.dmdirc.Precondition;
 import com.dmdirc.interfaces.CommandController;
 
 import java.util.Arrays;
@@ -190,7 +189,6 @@ public class CommandArguments {
      *
      * @return A String representation of the requested words
      */
-    @Precondition("Start index is less than or equal to end index")
     public String getWordsAsString(final int start, final int end) {
         checkPositionIndex(start, end);
 

src/main/java/com/dmdirc/commandparser/commands/Command.java → api/src/main/java/com/dmdirc/commandparser/commands/BaseCommand.java

@@ -36,12 +36,12 @@ import javax.annotation.Nullable;
 /**
  * Represents a generic command.
  */
-public abstract class Command {
+public abstract class BaseCommand implements Command {
 
     /** The controller this command is associated with. */
     private final CommandController controller;
 
-    public Command(final CommandController controller) {
+    public BaseCommand(final CommandController controller) {
         this.controller = controller;
     }
 
@@ -147,16 +147,4 @@ public abstract class Command {
         }
     }
 
-    /**
-     * Executes this command.
-     *
-     * @param origin  The container which received the command
-     * @param args    Arguments passed to this command
-     * @param context The context the command was executed in
-     *
-     * @since 0.6.4
-     */
-    public abstract void execute(@Nonnull WindowModel origin, CommandArguments args,
-            CommandContext context);
-
 }

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

@@ -0,0 +1,45 @@
+/*
+ * 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.commandparser.commands;
+
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.interfaces.WindowModel;
+
+import javax.annotation.Nonnull;
+
+/**
+ * A command responds to user-input in a text field.
+ */
+public interface Command {
+
+    /**
+     * Executes this command.
+     *
+     * @param origin  The container which received the command
+     * @param args    Arguments passed to this command
+     * @param context The context the command was executed in
+     */
+    void execute(@Nonnull WindowModel origin, CommandArguments args, CommandContext context);
+
+}

api/src/main/java/com/dmdirc/commandparser/parsers/CommandParser.java

@@ -0,0 +1,96 @@
+/*
+ * 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.commandparser.parsers;
+
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandInfoPair;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.interfaces.WindowModel;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import java.util.Map;
+
+/**
+ * A command parser takes a line of input from the user, determines if it is an attempt at executing a command (based
+ * on the character at the start of the string), and handles it appropriately.
+ */
+public interface CommandParser {
+
+    /**
+     * Registers the specified command with this parser.
+     *
+     * @param command Command to be registered
+     * @param info    The information the command should be registered with
+     */
+    void registerCommand(Command command, CommandInfo info);
+
+    /**
+     * Unregisters the specified command with this parser.
+     *
+     * @param info Command information to be unregistered
+     */
+    void unregisterCommand(CommandInfo info);
+
+    /**
+     * Retrieves a map of commands known by this command parser.
+     *
+     * @return A map of commands known to this parser
+     */
+    Map<String, CommandInfoPair> getCommands();
+
+    /**
+     * Parses the specified string as a command.
+     *
+     * @param origin       The container which received the command
+     * @param line         The line to be parsed
+     * @param parseChannel Whether or not to try and parse the first argument as a channel name
+     */
+    void parseCommand(@Nonnull WindowModel origin, String line, boolean parseChannel);
+
+    /**
+     * Parses the specified string as a command.
+     *
+     * @param origin The container which received the command
+     * @param line   The line to be parsed
+     */
+    void parseCommand(@Nonnull WindowModel origin, String line);
+
+    /**
+     * Handles the specified string as a non-command.
+     *
+     * @param origin The window in which the command was typed
+     * @param line   The line to be parsed
+     */
+    void parseCommandCtrl(WindowModel origin, String line);
+
+    /**
+     * Gets the command with the given name that was previously registered with this parser.
+     *
+     * @param commandName The name of the command to retrieve.
+     * @return The command info pair, or {@code null} if the command does not exist.
+     */
+    @Nullable
+    CommandInfoPair getCommand(String commandName);
+
+}

src/main/java/com/dmdirc/events/BaseDisplayableEvent.java → api/src/main/java/com/dmdirc/events/BaseDisplayableEvent.java

@@ -28,7 +28,7 @@ import java.time.LocalDateTime;
 import java.util.Optional;
 
 /**
- * Base class for miscallenous displayable events.
+ * Base class for miscellaneous displayable events.
  */
 public abstract class BaseDisplayableEvent extends DMDircEvent implements DisplayableEvent {
 

api/src/main/java/com/dmdirc/events/DisplayProperty.java

@@ -22,10 +22,11 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.interfaces.User;
 import com.dmdirc.util.colours.Colour;
 
 /**
- * Describes a property that may be set on a {@link DisplayableEvent} to affect its display.
+ * Describes a property that may be set on a {@link com.dmdirc.interfaces.Displayable} to affect its display.
  */
 @SuppressWarnings("UnusedDeclaration") // Generic type used for compile-time validation only
 public interface DisplayProperty<T> {
@@ -38,6 +39,8 @@ public interface DisplayProperty<T> {
     DisplayProperty<Boolean> DO_NOT_DISPLAY = new DisplayPropertyImpl<>();
     /** Whether to suppress timestamps for the event. */
     DisplayProperty<Boolean> NO_TIMESTAMPS = new DisplayPropertyImpl<>();
+    /** A user that the displayable is linked to. */
+    DisplayProperty<User> LINK_USER = new DisplayPropertyImpl<>();
 
     final class DisplayPropertyImpl<T> implements DisplayProperty<T> {}
 

api/src/main/java/com/dmdirc/events/DisplayableEvent.java

@@ -0,0 +1,40 @@
+/*
+ * 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.events;
+
+import com.dmdirc.interfaces.Displayable;
+import java.time.LocalDateTime;
+
+/**
+ * Describes an event which is rendered in the client to the user.
+ */
+public interface DisplayableEvent extends SourcedEvent, Displayable {
+
+    /**
+     * Gets the times at which the event occurred.
+     *
+     * @return The time the event occurred at.
+     */
+    LocalDateTime getTimestamp();
+
+}