GUILog.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.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable2;
import com.realtime.crossfire.jxclient.gui.scrollable.ScrollableListener;
import com.realtime.crossfire.jxclient.skin.skin.GuiFactory;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.awt.Color;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsEnvironment;
import java.awt.Image;
import java.awt.Toolkit;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.StringSelection;
import java.awt.datatransfer.Transferable;
import java.awt.event.ActionListener;
import java.awt.event.MouseEvent;
import java.awt.font.FontRenderContext;
import java.awt.image.BufferedImage;
import java.util.Iterator;
import java.util.List;
import javax.swing.Timer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class GUILog extends AbstractGUIElement implements GUIScrollable2 {
 
    private static final long serialVersionUID = 1;
 
    private static final int SCROLL_PIXEL = 48;
 
    private static final int TIMEOUT_AUTO_SCROLL = 25;
 
    @NotNull
    private final EventListenerList2<ScrollableListener> listeners = new EventListenerList2<>();
 
    @NotNull
    private final Buffer buffer;
 
    @Nullable
    private final Image backgroundImage;
 
    @NotNull
    private final RenderStateManager renderStateManager;
 
    @NotNull
    private final Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
 
    @Nullable
    private final Clipboard selection = Toolkit.getDefaultToolkit().getSystemSelection();
 
    @NotNull
    private final ActionListener timeoutEvent = e -> autoScroll();
 
    @NotNull
    private final Timer timer = new Timer(TIMEOUT_AUTO_SCROLL, timeoutEvent);
 
    private int startSelection;
 
    private int beginSelection;
 
    private int endSelection;
 
    private boolean scrollForwards;
 
    @NotNull
    @SuppressWarnings("FieldCanBeLocal")
    private final RenderStateListener renderStateListener = new RenderStateListener() {
 
        @Override
        public void stateChanged() {
            setChanged();
            for (ScrollableListener listener : listeners) {
                listener.setRange(0, buffer.getTotalHeight(), renderStateManager.getScrollPos(), getHeight());
            }
        }
 
        @Override
        public int getHeight() {
            return Math.max(1, GUILog.this.getHeight());
        }
 
    };
 
    @NotNull
    private final BufferListener bufferListener = new BufferListener() {
 
        @Override
        public void lineAdded() {
            // does not affect the selection => ignore
        }
 
        @Override
        public void lineReplaced() {
            // does not affect the selection => ignore
        }
 
        @Override
        public void linesRemoved(@NotNull final List<Line> lines) {
            final int endPosition = lines.get(lines.size()-1).getEndPosition();
            if (beginSelection > endPosition) {
                beginSelection -= endPosition;
                endSelection -= endPosition;
            } else if (endSelection > endPosition) {
                beginSelection = 0;
                endSelection -= endPosition;
                copy();
            } else if (beginSelection > 0 || endSelection > 0) {
                beginSelection = 0;
                endSelection = 0;
                copy();
            }
        }
 
    };
 
    protected GUILog(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final Image backgroundImage, @NotNull final Fonts fonts, @NotNull final GuiFactory guiFactory) {
        super(tooltipManager, elementListener, name, false, guiFactory);
        this.backgroundImage = backgroundImage;
        final FontRenderContext context;
        final GraphicsEnvironment graphicsEnvironment = GraphicsEnvironment.getLocalGraphicsEnvironment();
        final Graphics2D g = graphicsEnvironment.createGraphics(new BufferedImage(1, 1, BufferedImage.TYPE_INT_ARGB)); // XXX
        try {
            context = g.getFontRenderContext();
        } finally {
            g.dispose();
        }
        buffer = new DefaultBuffer(fonts, context, getWidth());
        renderStateManager = new RenderStateManager(renderStateListener, buffer);
        renderStateManager.setHeight(getHeight());
        buffer.addBufferListener(bufferListener);
    }
 
    @Override
    public void dispose() {
        super.dispose();
        renderStateManager.dispose();
        buffer.removeBufferListener(bufferListener);
    }
 
    @Override
    public void paintComponent(@NotNull final Graphics g) {
        super.paintComponent(g);
 
        g.setColor(new Color(0, 0, 0, 0.0f));
        g.fillRect(0, 0, getWidth(), getHeight());
        if (backgroundImage != null) {
            g.drawImage(backgroundImage, 0, 0, null);
        }
 
        final int beginSelection = this.beginSelection;
        final int endSelection = this.endSelection;
        int y = -renderStateManager.getTopOffset();
        final int topIndex = renderStateManager.getTopIndex();
        synchronized (buffer.getSyncObject()) {
            for (final Line line : buffer.lines(topIndex)) {
                if (y >= getHeight()) {
                    break;
                }
                final int height = line.getHeight();
                if (height > 0) {
                    line.drawLine((Graphics2D)g, y, beginSelection, endSelection);
                    y += height;
                }
            }
        }
    }
 
    @Override
    public boolean canScroll(final int distance) { // XXX: implement |distance|>1
        if (distance < 0) {
            return renderStateManager.canScrollUp();
        }
        //noinspection SimplifiableIfStatement
        if (distance > 0) {
            return renderStateManager.canScrollDown();
        }
        return false;
    }
 
    @Override
    public void scroll(final int distance) {
        if (distance < 0) {
            renderStateManager.scrollUp(-distance*SCROLL_PIXEL);
        } else if (distance > 0) {
            renderStateManager.scrollDown(distance*SCROLL_PIXEL);
        } else {
            assert false;
        }
    }
 
    @Override
    public void resetScroll() {
        renderStateManager.resetScroll();
    }
 
    @Override
    public void scrollTo(final int pos) {
        renderStateManager.scrollTo(pos);
    }
 
    @Override
    public void addScrollableListener(@NotNull final ScrollableListener listener) {
        listeners.add(listener);
    }
 
    @Override
    public void removeScrollableListener(@NotNull final ScrollableListener listener) {
        listeners.remove(listener);
    }
 
    @NotNull
    public Buffer getBuffer() {
        return buffer;
    }
 
    @Override
    public void setBounds(final int x, final int y, final int width, final int height) {
        super.setBounds(x, y, width, height);
        buffer.setRenderWidth(width);
        renderStateManager.setHeight(height);
    }
 
    @Override
    public void mousePressed(@NotNull final MouseEvent e) {
        super.mousePressed(e);
        startSelection = buffer.coordinateToPosition(e.getX(), e.getY()+renderStateManager.getScrollPos());
        if (timer.isRunning()) {
            timer.stop();
        }
        setSelection(startSelection);
    }
 
    @Override
    public void mouseReleased(@NotNull final MouseEvent e) {
        super.mouseReleased(e);
        setSelection(Math.min(Math.max(buffer.coordinateToPosition(e.getX(), e.getY()+renderStateManager.getScrollPos()), getStartPosition()), getEndPosition()));
        if (timer.isRunning()) {
            timer.stop();
        }
        copy();
    }
 
    @Override
    public void mouseDragged(@NotNull final MouseEvent e) {
        super.mouseDragged(e);
 
        if (e.getY() < 0) {
            setSelection(getStartPosition());
            if (!timer.isRunning()) {
                scrollForwards = false;
                timer.start();
            }
        } else if (e.getY() >= getHeight()) {
            setSelection(getEndPosition());
            if (!timer.isRunning()) {
                scrollForwards = true;
                timer.start();
            }
        } else {
            setSelection(buffer.coordinateToPosition(e.getX(), e.getY()+renderStateManager.getScrollPos()));
            if (timer.isRunning()) {
                timer.stop();
            }
        }
    }
 
    @Override
    public void mouseWheelMoved(final int wheelRotation) {
        super.mouseWheelMoved(wheelRotation);
        scroll(wheelRotation);
    }
 
    private void autoScroll() {
        if (scrollForwards) {
            if (renderStateManager.canScrollDown()) {
                renderStateManager.scrollDown(SCROLL_PIXEL);
                setSelection(getEndPosition());
            }
        } else {
            if (renderStateManager.canScrollUp()) {
                renderStateManager.scrollUp(SCROLL_PIXEL);
                setSelection(getStartPosition());
                if (!renderStateManager.canScrollUp()) {
                    timer.stop();
                }
            }
        }
    }
 
    private int getStartPosition() {
        return buffer.coordinateToPosition(0, renderStateManager.getScrollPos());
    }
 
    private int getEndPosition() {
        return buffer.coordinateToPosition(0, renderStateManager.getHeight()+renderStateManager.getScrollPos());
    }
 
    public void setShowSentCommands(final boolean showSentCommands) {
        final int oldBufferHeight = buffer.getTotalHeight();
        buffer.setShowSentCommands(showSentCommands);
        renderStateManager.update(oldBufferHeight);
        copy();
    }
 
    public void setShowTimestamps(final boolean showTimestamps) {
        final int oldBufferHeight = buffer.getTotalHeight();
        buffer.setShowTimestamps(showTimestamps);
        renderStateManager.update(oldBufferHeight);
        copy();
    }
 
    private void setSelection(final int selection) {
        final int newBeginSelection = Math.min(startSelection, selection);
        final int newEndSelection = Math.max(startSelection, selection);
        if (beginSelection == newBeginSelection && endSelection == newEndSelection) {
            return;
        }
 
        beginSelection = newBeginSelection;
        endSelection = newEndSelection;
        repaint();
    }
 
    private void copy() {
        final Transferable selection = new StringSelection(buffer.getText(beginSelection, endSelection));
        if (this.selection != null) {
            this.selection.setContents(selection, null);
        }
        clipboard.setContents(selection, null);
    }
 
}