MessageBufferUpdater.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.gui.log;
 
import com.realtime.crossfire.jxclient.protocol.MessageType;
import com.realtime.crossfire.jxclient.protocol.MessageTypes;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawextinfoListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireQueryListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import java.awt.Color;
import org.jetbrains.annotations.NotNull;
 
public class MessageBufferUpdater {
 
    public static final int NUM_COLORS = 13;
 
    @NotNull
    private final Color @NotNull [] colors = { //
        new Color(0x000000), // black
        new Color(0xB000D5), // white
        new Color(0x362589), // navy blue
        new Color(0xD80C1B), // red
        new Color(0x92440A), // orange
        new Color(0xBF580B), // dodger blue
        new Color(0x914F1E), // dark orange
        new Color(0x275A0F), // sea green
        new Color(0x346B1A), // dark sea green
        new Color(0x353535), // grey
        new Color(0x775716), // brown sienna
        new Color(0x999B26), // gold
        new Color(0x6C6E20), // khaki
    };
 
    @NotNull
    private static final String @NotNull [] COLOR_NAMES = { //
        "black", //
        "white", //
        "navy blue", //
        "red", //
        "orange", //
        "dodger blue", //
        "dark orange", //
        "sea green", //
        "dark sea green", //
        "grey", //
        "brown sienna", //
        "gold", //
        "khaki", //
    };
 
    @NotNull
    private final CrossfireServerConnection crossfireServerConnection;
 
    @NotNull
    private final Parser parser;
 
    @NotNull
    private final Color defaultColor;
 
    @NotNull
    private final Buffer buffer;
 
    @NotNull
    @SuppressWarnings("ZeroLengthArrayAllocation")
    private MessageTypes types = new MessageTypes(false, new int[0]);
 
    private boolean printMessageTypes;
 
    @NotNull
    private final CrossfireQueryListener crossfireQueryListener = new CrossfireQueryListener() {
 
        @Override
        public void commandQueryReceived(@NotNull final String prompt, final int queryType) {
            if (types.isTypeShown(MessageType.MSG_TYPE_JXCLIENT, MessageType.MSG_SUBTYPE_JXCLIENT_QUERY)) {
                parser.parseWithoutMediaTags(addMessageTypePrefix(MessageType.MSG_TYPE_JXCLIENT, MessageType.MSG_SUBTYPE_JXCLIENT_QUERY, CrossfireDrawinfoListener.NDI_RED, prompt), MessageType.MSG_TYPE_JXCLIENT, MessageType.MSG_SUBTYPE_JXCLIENT_QUERY, findColor(CrossfireDrawinfoListener.NDI_RED), buffer);
            }
        }
 
    };
 
    @NotNull
    private final CrossfireDrawextinfoListener crossfireDrawextinfoListener = new CrossfireDrawextinfoListener() {
 
        @Override
        public void commandDrawextinfoReceived(final int color, final int type, final int subtype, @NotNull final String message) {
            if (types.isTypeShown(type, subtype)) {
                final CharSequence messageWithPrefix = addMessageTypePrefix(type, subtype, color, message);
                if (type == MessageType.MSG_TYPE_COMMUNICATION) {
                    //noinspection ConstantValueVariableUse
                    parser.parseWithoutMediaTags(messageWithPrefix, type, subtype, findColor(color), buffer);
                } else {
                    parser.parse(messageWithPrefix, type, subtype, findColor(color), buffer);
                }
            }
        }
 
        @Override
        public void setDebugMode(final boolean printMessageTypes) {
            MessageBufferUpdater.this.printMessageTypes = printMessageTypes;
        }
 
    };
 
    @NotNull
    private final CrossfireDrawinfoListener crossfireDrawinfoListener = new CrossfireDrawinfoListener() {
 
        @Override
        public void commandDrawinfoReceived(@NotNull final String text, final int type) {
            // guess category from message color
            final int messageType = switch (type) {
                case NDI_WHITE, NDI_ORANGE, NDI_BLUE, NDI_RED -> MessageType.MSG_TYPE_COMMUNICATION;
                default -> MessageType.MSG_TYPE_MISC;
            };
 
            if (types.isTypeShown(messageType, MessageType.MSG_SUBTYPE_NONE)) {
                parser.parseWithoutMediaTags(addMessageTypePrefix(messageType, 0, type, text), messageType, MessageType.MSG_SUBTYPE_NONE, findColor(type), buffer);
            }
        }
 
    };
 
    public MessageBufferUpdater(@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final Buffer buffer, @NotNull final Color defaultColor, @NotNull final Color selectionColor) {
        this.crossfireServerConnection = crossfireServerConnection;
        this.buffer = buffer;
        parser = new Parser(selectionColor);
        this.defaultColor = defaultColor;
        this.crossfireServerConnection.addCrossfireQueryListener(crossfireQueryListener);
        this.crossfireServerConnection.addCrossfireDrawextinfoListener(crossfireDrawextinfoListener);
        this.crossfireServerConnection.addCrossfireDrawinfoListener(crossfireDrawinfoListener);
    }
 
    public void dispose() {
        crossfireServerConnection.removeCrossfireQueryListener(crossfireQueryListener);
        crossfireServerConnection.removeCrossfireDrawextinfoListener(crossfireDrawextinfoListener);
        crossfireServerConnection.removeCrossfireDrawinfoListener(crossfireDrawinfoListener);
    }
 
    @NotNull
    private Color findColor(final int index) {
        try {
            return colors[index];
        } catch (final ArrayIndexOutOfBoundsException ignored) {
            return defaultColor;
        }
    }
 
    @NotNull
    public static String getColorName(final int index) {
        try {
            return COLOR_NAMES[index];
        } catch (final ArrayIndexOutOfBoundsException ignored) {
            return "undefined";
        }
    }
 
    public void setColor(final int index, @NotNull final Color color) {
        colors[index] = color;
    }
 
    public void setTypes(@NotNull final MessageTypes types) {
        this.types = types;
    }
 
    @NotNull
    private CharSequence addMessageTypePrefix(final int type, final int subtype, final int color, @NotNull final CharSequence message) {
        return printMessageTypes ? "(t="+MessageType.toString(type, subtype)+"/"+subtype+",c="+color+")"+message : message;
    }
 
}