DMDirc-Plugins/ui_swing/src/com/dmdirc/addons/ui_swing/textpane/TextPane.java

/*
 * 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.addons.ui_swing.textpane;

import com.dmdirc.addons.ui_swing.UIUtilities;
import com.dmdirc.interfaces.config.ConfigChangeListener;
import com.dmdirc.interfaces.ui.Window;
import com.dmdirc.ui.messages.CachingDocument;
import com.dmdirc.ui.messages.IRCDocument;
import com.dmdirc.ui.messages.IRCDocumentListener;
import com.dmdirc.ui.messages.LinePosition;
import com.dmdirc.ui.messages.Styliser;
import com.dmdirc.util.StringUtils;
import com.dmdirc.util.URLBuilder;

import java.awt.Adjustable;
import java.awt.Color;
import java.awt.Point;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.StringSelection;
import java.awt.event.AdjustmentEvent;
import java.awt.event.AdjustmentListener;
import java.awt.event.InputEvent;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionAdapter;
import java.awt.event.MouseMotionListener;
import java.awt.event.MouseWheelEvent;
import java.awt.event.MouseWheelListener;

import javax.swing.BoundedRangeModel;
import javax.swing.DefaultBoundedRangeModel;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JLayer;
import javax.swing.JScrollBar;
import javax.swing.SwingConstants;

import net.miginfocom.swing.MigLayout;

import static com.google.common.base.Preconditions.checkArgument;

/**
 * Styled, scrollable text pane.
 */
public final class TextPane extends JComponent implements MouseWheelListener,
        AdjustmentListener, IRCDocumentListener, ConfigChangeListener {

    /** A version number for this class. */
    private static final long serialVersionUID = 5;
    /** Scrollbar model. */
    private final BoundedRangeModel scrollModel;
    /** Canvas object, used to draw text. */
    private final TextPaneCanvas canvas;
    /** IRCDocument. */
    private final IRCDocument document;
    /** Parent Frame. */
    private final Window frame;
    /** Indicator to show whether new lines have been added. */
    private final JLabel newLineIndicator;
    /** Background painter. */
    private final BackgroundPainter backgroundPainter;
    /** The domain to read configuration from. */
    private final String configDomain;
    /** Clipboard to handle copy and paste cations. */
    private final Clipboard clipboard;
    /** Last seen line. */
    private int lastSeenLine;
    /** Show new line notifications. */
    private boolean showNotification;

    /**
     * Creates a new instance of TextPane.
     *
     * @param configDomain The domain to read configuration from.
     * @param urlBuilder   The builder to use to construct URLs for resources.
     * @param clipboard    The clipboard to handle copy and paste actions
     * @param frame        Parent Frame
     */
    public TextPane(
            final String configDomain,
            final URLBuilder urlBuilder, final Clipboard clipboard,
            final Window frame) {
        this.frame = frame;
        this.configDomain = configDomain;
        this.clipboard = clipboard;

        setUI(new TextPaneUI());
        document = frame.getContainer().getBackBuffer().getDocument();
        newLineIndicator = new JLabel("", SwingConstants.CENTER);
        newLineIndicator.setBackground(Color.RED);
        newLineIndicator.setForeground(Color.WHITE);
        newLineIndicator.setOpaque(true);
        newLineIndicator.setVisible(false);

        setLayout(new MigLayout("fill, hidemode 3"));
        backgroundPainter = new BackgroundPainter(frame.getContainer().getConfigManager(),
                urlBuilder, configDomain, "textpanebackground",
                "textpanebackgroundoption", "textpanebackgroundopacity");
        canvas = new TextPaneCanvas(this,
                new CachingDocument<>(document, new AttributedStringMessageMaker()));
        final JLayer<JComponent> layer = new JLayer<>(canvas);
        layer.setUI(backgroundPainter);
        add(layer, "dock center");
        add(newLineIndicator, "dock south, center, grow");
        scrollModel = new DefaultBoundedRangeModel();
        scrollModel.setMaximum(0);
        scrollModel.setExtent(0);
        final JScrollBar scrollBar = new JScrollBar(Adjustable.VERTICAL);
        scrollBar.setModel(scrollModel);
        add(scrollBar, "dock east");
        scrollBar.addAdjustmentListener(this);
        scrollBar.addAdjustmentListener(canvas);
        frame.getContainer().getConfigManager().addChangeListener(configDomain,
                "textpanelinenotification", this);
        configChanged("", "textpanelinenotification");

        addMouseWheelListener(this);
        document.addIRCDocumentListener(this);
        setAutoscrolls(true);

        final MouseMotionListener doScrollRectToVisible = new MouseMotionAdapter() {

            @Override
            public void mouseDragged(final MouseEvent e) {
                if (e.getXOnScreen() > getLocationOnScreen().getX()
                        && e.getXOnScreen() < getLocationOnScreen().getX() + getWidth()
                        && e.getModifiersEx() == InputEvent.BUTTON1_DOWN_MASK) {
                    if (getLocationOnScreen().getY() > e.getYOnScreen()) {
                        scrollModel.setValue(scrollBar.getValue() - 1);
                    } else if (getLocationOnScreen().getY() + getHeight()
                            < e.getYOnScreen()) {
                        scrollModel.setValue(scrollBar.getValue() + 1);
                    }
                    canvas.highlightEvent(MouseEventType.DRAG, e);
                }
            }
        };
        addMouseMotionListener(doScrollRectToVisible);

        setRangeProperties(document.getNumLines() - 1, document.getNumLines() - 1);
    }

    /**
     * Sets the range properties of the scroll model. This method takes into account the scroll
     * model working with 0 indexed line numbers.
     *
     * @param max   Total number of lines
     * @param value Current line
     */
    private void setRangeProperties(final int max, final int value) {
        if (max == 1) {
            scrollModel.setRangeProperties(1, 0, 1, 1, false);
        } else {
            scrollModel.setRangeProperties(value, 0, 0, max - 1, false);
        }
    }

    @Override
    public void updateUI() {
        setUI(new TextPaneUI());
    }

    /**
     * Returns the last visible line in the TextPane.
     *
     * @return Last visible line index
     */
    public int getLastVisibleLine() {
        return scrollModel.getValue();
    }

    /**
     * Sets the new position for the scrollbar and the associated position to render the text from.
     *
     * @param position new position of the scrollbar
     */
    public void setScrollBarPosition(final int position) {
        scrollModel.setValue(position);
    }

    @Override
    public void adjustmentValueChanged(final AdjustmentEvent e) {
        if (showNotification && e.getValue() >= scrollModel.getMaximum()) {
            newLineIndicator.setVisible(false);
        }

        lastSeenLine = Math.max(lastSeenLine, e.getValue());

        final int lines = scrollModel.getMaximum() - lastSeenLine;
        newLineIndicator.setText("↓ " + lines + " new line"
                + (lines == 1 ? "" : "s") + " ↓");
    }

    @Override
    public void mouseWheelMoved(final MouseWheelEvent e) {
        if (e.getWheelRotation() > 0) {
            scrollModel.setValue(scrollModel.getValue() + e.getScrollAmount());
        } else {
            scrollModel.setValue(scrollModel.getValue() - e.getScrollAmount());
        }
    }

    /**
     *
     * Returns the line information from a mouse click inside the TextPane.
     *
     * @param point mouse position
     *
     * @return line number, line part, position in whole line
     */
    public LineInfo getClickPosition(final Point point) {
        return canvas.getClickPosition(point, true);
    }

    /**
     *
     * Returns the line information from a mouse click inside the TextPane.
     *
     * @param point     mouse position
     * @param selection Are we selecting text?
     *
     * @return line number, line part, position in whole line
     *
     * @since 0.6.3
     */
    public LineInfo getClickPosition(final Point point,
            final boolean selection) {
        return canvas.getClickPosition(point, selection);
    }

    /**
     * Returns the selected text.
     *
     * @param styled Return styled text?
     *
     * @return Selected text
     */
    public String getSelectedText(final boolean styled) {
        final StringBuilder selectedText = new StringBuilder();
        final LinePosition selectedRange = canvas.getSelectedRange();

        if (selectedRange.getStartLine() == -1) {
            return null;
        }

        for (int i = selectedRange.getStartLine(); i <= selectedRange.getEndLine(); i++) {
            if (i != selectedRange.getStartLine()) {
                selectedText.append('\n');
            }
            if (scrollModel.getMaximum() < i) {
                return selectedText.toString();
            }
            final String line;
            if (styled) {
                line = document.getLine(i).getStyledText();
            } else {
                line = document.getLine(i).getText();
            }
            if (!line.isEmpty()) {
                if (selectedRange.getEndLine() == selectedRange.getStartLine()) {
                    //loop through range
                    if (selectedRange.getStartPos() != -1 && selectedRange.getEndPos() != -1) {
                        selectedText.append(getText(line,
                                selectedRange.getStartPos(),
                                selectedRange.getEndPos(), styled));
                    }
                } else if (i == selectedRange.getStartLine()) {
                    //loop from start of range to the end
                    final int length = Styliser.stipControlCodes(line).length();
                    if (selectedRange.getStartPos() != -1 && selectedRange.getStartPos() < length) {
                        // Ensure that we're actually selecting some text on this line
                        selectedText.append(getText(line, selectedRange.getStartPos(), length,
                                styled));
                    }
                } else if (i == selectedRange.getEndLine()) {
                    //loop from start to end of range
                    if (selectedRange.getEndPos() > 0) {
                        selectedText.append(getText(line, 0, selectedRange.getEndPos(), styled));
                    }
                } else {
                    //loop the whole line
                    final int length = Styliser.stipControlCodes(line).length();
                    selectedText.append(getText(line, 0, length, styled));
                }
            }
        }

        return selectedText.toString();
    }

    /**
     * Gets a range of text (styled or unstyled) from the given text.
     *
     * @param text   Text to extract text from
     * @param start  Start index
     * @param end    End index
     * @param styled Styled text?
     *
     * @return Requested text range as a String
     */
    private String getText(final String text, final int start, final int end,
            final boolean styled) {
        checkArgument(start < end, "'start' (" + start + ") must be less than 'end' (" + end + ')');
        checkArgument(start >= 0, "'start' (" + start + ") must be non-negative");

        if (styled) {
            return Styliser.getStyledText(text, start, end);
        } else {
            return text.substring(start, end);
        }
    }

    /**
     * Returns the selected range.
     *
     * @return selected range
     */
    public LinePosition getSelectedRange() {
        return canvas.getSelectedRange();
    }

    /**
     * Returns whether there is a selected range.
     *
     * @return true iif there is a selected range
     */
    public boolean hasSelectedRange() {
        final LinePosition selectedRange = canvas.getSelectedRange();
        return !(selectedRange.getStartLine() == selectedRange.getEndLine()
                && selectedRange.getStartPos() == selectedRange.getEndPos());
    }

    /**
     * Selects the specified region of text.
     *
     * @param position Line position
     */
    public void setSelectedText(final LinePosition position) {
        canvas.setSelectedRange(position);
    }

    /**
     * Returns the type of text this click represents.
     *
     * @param lineInfo Line info of click.
     *
     * @return Click type for specified position
     */
    public ClickTypeValue getClickType(final LineInfo lineInfo) {
        return canvas.getClickType(lineInfo);
    }

    /**
     * Returns the surrounding word at the specified position.
     *
     * @param lineNumber Line number to get word from
     * @param index      Position to get surrounding word
     *
     * @return Surrounding word
     */
    public String getWordAtIndex(final int lineNumber, final int index) {
        if (lineNumber == -1) {
            return "";
        }
        final int[] indexes = StringUtils.indiciesOfWord(document.getLine(lineNumber).getText(),
                index);
        return document.getLine(lineNumber).getText().substring(indexes[0], indexes[1]);
    }

    /** Adds the selected text to the clipboard. */
    public void copy() {
        copy(false);
    }

    /**
     * Adds the selected text to the clipboard.
     *
     * @param copyControlCharacters Should we copy control codes, or strip them?
     */
    public void copy(final boolean copyControlCharacters) {
        if (getSelectedText(false) != null && !getSelectedText(false).isEmpty()) {
            clipboard.setContents(new StringSelection(getSelectedText(copyControlCharacters)), null);
        }
    }

    /** Clears the TextPane. */
    public void clear() {
        UIUtilities.invokeLater(document::clear);
    }

    /** Clears the selection. */
    public void clearSelection() {
        canvas.clearSelection();
    }

    /** Scrolls one page up in the TextPane. */
    public void pageDown() {
        scrollModel.setValue(scrollModel.getValue() + 10);
    }

    /** Scrolls one page down in the TextPane. */
    public void pageUp() {
        scrollModel.setValue(scrollModel.getValue() - 10);
    }

    /** Scrolls to the beginning of the TextPane. */
    public void goToHome() {
        scrollModel.setValue(0);
    }

    /** Scrolls to the end of the TextPane. */
    public void goToEnd() {
        scrollModel.setValue(scrollModel.getMaximum());
    }

    @Override
    public void trimmed(final int newSize, final int numTrimmed) {
        UIUtilities.invokeLater(() -> {
            lastSeenLine -= numTrimmed;
            final LinePosition selectedRange = getSelectedRange();
            selectedRange.setStartLine(selectedRange.getStartLine() - numTrimmed);
            selectedRange.setEndLine(selectedRange.getEndLine() - numTrimmed);
            if (selectedRange.getStartLine() < 0) {
                selectedRange.setStartLine(0);
            }
            if (selectedRange.getEndLine() < 0) {
                selectedRange.setEndLine(0);
            }
            setSelectedText(selectedRange);
            if (scrollModel.getValue() == scrollModel.getMaximum()) {
                setRangeProperties(newSize, newSize);
            } else {
                setRangeProperties(newSize, scrollModel.getValue() - numTrimmed);
            }
        });
    }

    @Override
    public void cleared() {
        UIUtilities.invokeLater(() -> {
            scrollModel.setMaximum(0);
            scrollModel.setValue(0);
            canvas.recalc();
        });
    }

    @Override
    public void linesAdded(final int line, final int length, final int size) {
        UIUtilities.invokeLater(() -> {
            if (scrollModel.getValue() == scrollModel.getMaximum()) {
                setRangeProperties(size, size);
            } else {
                setRangeProperties(size, scrollModel.getValue());
                if (showNotification) {
                    newLineIndicator.setVisible(true);
                }
            }
        });
    }

    @Override
    public void repaintNeeded() {
        UIUtilities.invokeLater(canvas::recalc);
    }

    /**
     * Retrieves this TextPane's IRCDocument.
     *
     * @return This TextPane's IRC document
     */
    public IRCDocument getDocument() {
        return document;
    }

    /**
     * Retrieves the parent window for this TextPane.
     *
     * @return Parent window
     */
    public Window getWindow() {
        return frame;
    }

    /**
     * Adds a TextPane listener to this TextPane.
     *
     * @param listener Listener to add
     */
    public void addTextPaneListener(final TextPaneListener listener) {
        canvas.addTextPaneListener(listener);
    }

    /**
     * Removes a TextPane listener from this TextPane.
     *
     * @param listener Listener to remove
     */
    public void removeTextPaneListener(final TextPaneListener listener) {
        canvas.removeTextPaneListener(listener);
    }

    @Override
    public void configChanged(final String domain, final String key) {
        showNotification = frame.getContainer().getConfigManager()
                .getOptionBool(configDomain, "textpanelinenotification");
        if (!showNotification) {
            UIUtilities.invokeLater(() -> newLineIndicator.setVisible(false));
        }
    }

    /**
     * Called to close this TextPane and any associated resources.
     */
    public void close() {
        backgroundPainter.unbind();
    }

}