#49 reduce use of synchronized
[fanfix.git] / src / jexer / TTerminalWindow.java
index d17a2c4cdd53b3564fbb952276834f35822146b3..5970b6c77aff4791a389d13a7aa9a1012dbf5147 100644 (file)
  */
 package jexer;
 
-import java.awt.image.BufferedImage;
 import java.awt.Font;
 import java.awt.FontMetrics;
 import java.awt.Graphics2D;
+import java.awt.image.BufferedImage;
 
 import java.io.InputStream;
 import java.io.IOException;
@@ -44,6 +44,7 @@ import java.util.Map;
 import java.util.ResourceBundle;
 
 import jexer.backend.ECMA48Terminal;
+import jexer.backend.GlyphMaker;
 import jexer.backend.MultiScreen;
 import jexer.backend.SwingTerminal;
 import jexer.bits.Cell;
@@ -96,41 +97,51 @@ public class TTerminalWindow extends TScrollableWindow
     private boolean closeOnExit = false;
 
     /**
-     * System-dependent Y adjustment for text in the character cell
-     * (double-height).
+     * Double-height font.
      */
-    private int doubleTextAdjustY = 0;
+    private GlyphMaker doubleFont;
 
     /**
-     * System-dependent X adjustment for text in the character cell
-     * (double-height).
+     * Last text width value.
      */
-    private int doubleTextAdjustX = 0;
+    private int lastTextWidth = -1;
 
     /**
-     * Descent of a character cell in pixels (double-height).
+     * Last text height value.
      */
-    private int doubleMaxDescent = 0;
+    private int lastTextHeight = -1;
 
     /**
-     * Double-width font.
+     * The blink state, used only by ECMA48 backend and when double-width
+     * chars must be drawn.
      */
-    private Font doubleFont = null;
+    private boolean blinkState = true;
 
     /**
-     * Last text width value.
+     * Timer flag, used only by ECMA48 backend and when double-width chars
+     * must be drawn.
      */
-    private int lastTextWidth = -1;
+    private boolean haveTimer = false;
 
     /**
-     * Last text height value.
+     * The last seen scrollback lines.
      */
-    private int lastTextHeight = -1;
+    private List<DisplayLine> scrollback;
 
     /**
-     * A cache of previously-rendered double-width glyphs.
+     * The last seen display lines.
      */
-    private Map<Cell, BufferedImage> glyphCache;
+    private List<DisplayLine> display;
+
+    /**
+     * If true, the display has changed and needs updating.
+     */
+    private volatile boolean dirty = true;
+
+    /**
+     * Time that the display was last updated.
+     */
+    private long lastUpdateTime = 0;
 
     // ------------------------------------------------------------------------
     // Constructors -----------------------------------------------------------
@@ -315,96 +326,125 @@ public class TTerminalWindow extends TScrollableWindow
      */
     @Override
     public void draw() {
-        // Synchronize against the emulator so we don't stomp on its reader
-        // thread.
-        synchronized (emulator) {
-
-            // Update the scroll bars
-            reflowData();
-
-            // Draw the box using my superclass
-            super.draw();
 
-            List<DisplayLine> scrollback = emulator.getScrollbackBuffer();
-            List<DisplayLine> display = emulator.getDisplayBuffer();
+        int width = getDisplayWidth();
+        boolean syncEmulator = false;
+        if ((System.currentTimeMillis() - lastUpdateTime > 125)
+            && (dirty == true)
+        ) {
+            // Too much time has passed, draw it all.
+            syncEmulator = true;
+        } else if (emulator.isReading() && (dirty == false)) {
+            // Wait until the emulator has brought more data in.
+            syncEmulator = false;
+        } else if (!emulator.isReading() && (dirty == true)) {
+            // The emulator won't receive more data, update the display.
+            syncEmulator = true;
+        }
 
-            // Put together the visible rows
-            int visibleHeight = getHeight() - 2;
-            int visibleBottom = scrollback.size() + display.size()
-                + getVerticalValue();
-            assert (visibleBottom >= 0);
+        if ((syncEmulator == true)
+            || (scrollback == null)
+            || (display == null)
+        ) {
+            // We want to minimize the amount of time we have the emulator
+            // locked.  Grab a copy of its display.
+            synchronized (emulator) {
+                // Update the scroll bars
+                reflowData();
 
-            List<DisplayLine> preceedingBlankLines = new ArrayList<DisplayLine>();
-            int visibleTop = visibleBottom - visibleHeight;
-            if (visibleTop < 0) {
-                for (int i = visibleTop; i < 0; i++) {
-                    preceedingBlankLines.add(emulator.getBlankDisplayLine());
+                if ((scrollback == null) || emulator.isReading()) {
+                    scrollback = copyBuffer(emulator.getScrollbackBuffer());
+                    display = copyBuffer(emulator.getDisplayBuffer());
                 }
-                visibleTop = 0;
+                width = emulator.getWidth();
             }
-            assert (visibleTop >= 0);
+            dirty = false;
+        }
 
-            List<DisplayLine> displayLines = new ArrayList<DisplayLine>();
-            displayLines.addAll(scrollback);
-            displayLines.addAll(display);
+        // Draw the box using my superclass
+        super.draw();
 
-            List<DisplayLine> visibleLines = new ArrayList<DisplayLine>();
-            visibleLines.addAll(preceedingBlankLines);
-            visibleLines.addAll(displayLines.subList(visibleTop,
-                    visibleBottom));
+        // Put together the visible rows
+        int visibleHeight = getHeight() - 2;
+        int visibleBottom = scrollback.size() + display.size()
+                + getVerticalValue();
+        assert (visibleBottom >= 0);
 
-            visibleHeight -= visibleLines.size();
-            assert (visibleHeight >= 0);
+        List<DisplayLine> preceedingBlankLines = new ArrayList<DisplayLine>();
+        int visibleTop = visibleBottom - visibleHeight;
+        if (visibleTop < 0) {
+            for (int i = visibleTop; i < 0; i++) {
+                preceedingBlankLines.add(emulator.getBlankDisplayLine());
+            }
+            visibleTop = 0;
+        }
+        assert (visibleTop >= 0);
+
+        List<DisplayLine> displayLines = new ArrayList<DisplayLine>();
+        displayLines.addAll(scrollback);
+        displayLines.addAll(display);
+
+        List<DisplayLine> visibleLines = new ArrayList<DisplayLine>();
+        visibleLines.addAll(preceedingBlankLines);
+        visibleLines.addAll(displayLines.subList(visibleTop,
+                visibleBottom));
+
+        visibleHeight -= visibleLines.size();
+        assert (visibleHeight >= 0);
+
+        // Now draw the emulator screen
+        int row = 1;
+        for (DisplayLine line: visibleLines) {
+            int widthMax = width;
+            if (line.isDoubleWidth()) {
+                widthMax /= 2;
+            }
+            if (widthMax > getWidth() - 2) {
+                widthMax = getWidth() - 2;
+            }
+            for (int i = 0; i < widthMax; i++) {
+                Cell ch = line.charAt(i);
 
-            // Now draw the emulator screen
-            int row = 1;
-            for (DisplayLine line: visibleLines) {
-                int widthMax = emulator.getWidth();
-                if (line.isDoubleWidth()) {
-                    widthMax /= 2;
+                if (ch.isImage()) {
+                    putCharXY(i + 1, row, ch);
+                    continue;
                 }
-                if (widthMax > getWidth() - 2) {
-                    widthMax = getWidth() - 2;
-                }
-                for (int i = 0; i < widthMax; i++) {
-                    Cell ch = line.charAt(i);
-                    Cell newCell = new Cell();
-                    newCell.setTo(ch);
-                    boolean reverse = line.isReverseColor() ^ ch.isReverse();
-                    newCell.setReverse(false);
-                    if (reverse) {
-                        if (ch.getForeColorRGB() < 0) {
-                            newCell.setBackColor(ch.getForeColor());
-                            newCell.setBackColorRGB(-1);
-                        } else {
-                            newCell.setBackColorRGB(ch.getForeColorRGB());
-                        }
-                        if (ch.getBackColorRGB() < 0) {
-                            newCell.setForeColor(ch.getBackColor());
-                            newCell.setForeColorRGB(-1);
-                        } else {
-                            newCell.setForeColorRGB(ch.getBackColorRGB());
-                        }
+
+                Cell newCell = new Cell();
+                newCell.setTo(ch);
+                boolean reverse = line.isReverseColor() ^ ch.isReverse();
+                newCell.setReverse(false);
+                if (reverse) {
+                    if (ch.getForeColorRGB() < 0) {
+                        newCell.setBackColor(ch.getForeColor());
+                        newCell.setBackColorRGB(-1);
+                    } else {
+                        newCell.setBackColorRGB(ch.getForeColorRGB());
                     }
-                    if (line.isDoubleWidth()) {
-                        putDoubleWidthCharXY(line, (i * 2) + 1, row, newCell);
+                    if (ch.getBackColorRGB() < 0) {
+                        newCell.setForeColor(ch.getBackColor());
+                        newCell.setForeColorRGB(-1);
                     } else {
-                        putCharXY(i + 1, row, newCell);
+                        newCell.setForeColorRGB(ch.getBackColorRGB());
                     }
                 }
-                row++;
-                if (row == getHeight() - 1) {
-                    // Don't overwrite the box edge
-                    break;
+                if (line.isDoubleWidth()) {
+                    putDoubleWidthCharXY(line, (i * 2) + 1, row, newCell);
+                } else {
+                    putCharXY(i + 1, row, newCell);
                 }
             }
-            CellAttributes background = new CellAttributes();
-            // Fill in the blank lines on bottom
-            for (int i = 0; i < visibleHeight; i++) {
-                hLineXY(1, i + row, getWidth() - 2, ' ', background);
+            row++;
+            if (row == getHeight() - 1) {
+                // Don't overwrite the box edge
+                break;
             }
-
-        } // synchronized (emulator)
+        }
+        CellAttributes background = new CellAttributes();
+        // Fill in the blank lines on bottom
+        for (int i = 0; i < visibleHeight; i++) {
+            hLineXY(1, i + row, getWidth() - 2, ' ', background);
+        }
 
     }
 
@@ -500,25 +540,21 @@ public class TTerminalWindow extends TScrollableWindow
             return;
         }
 
-        // Synchronize against the emulator so we don't stomp on its reader
-        // thread.
-        synchronized (emulator) {
-            if (emulator.isReading()) {
-                // Get out of scrollback
-                setVerticalValue(0);
-                emulator.keypress(keypress.getKey());
+        if (emulator.isReading()) {
+            // Get out of scrollback
+            setVerticalValue(0);
+            emulator.addUserEvent(keypress);
 
-                // UGLY HACK TIME!  cmd.exe needs CRLF, not just CR, so if
-                // this is kBEnter then also send kbCtrlJ.
-                if (System.getProperty("os.name").startsWith("Windows")) {
-                    if (keypress.equals(kbEnter)) {
-                        emulator.keypress(kbCtrlJ);
-                    }
+            // UGLY HACK TIME!  cmd.exe needs CRLF, not just CR, so if
+            // this is kBEnter then also send kbCtrlJ.
+            if (System.getProperty("os.name").startsWith("Windows")) {
+                if (keypress.equals(kbEnter)) {
+                    emulator.addUserEvent(new TKeypressEvent(kbCtrlJ));
                 }
-
-                readEmulatorState();
-                return;
             }
+
+            readEmulatorState();
+            return;
         }
 
         // Process is closed, honor "normal" TUI keystrokes
@@ -538,22 +574,24 @@ public class TTerminalWindow extends TScrollableWindow
             return;
         }
 
-        if (mouse.isMouseWheelUp()) {
-            verticalDecrement();
-            return;
-        }
-        if (mouse.isMouseWheelDown()) {
-            verticalIncrement();
-            return;
-        }
-        if (mouseOnEmulator(mouse)) {
-            synchronized (emulator) {
-                mouse.setX(mouse.getX() - 1);
-                mouse.setY(mouse.getY() - 1);
-                emulator.mouse(mouse);
-                readEmulatorState();
+        // If the emulator is tracking mouse buttons, it needs to see wheel
+        // events.
+        if (emulator.getMouseProtocol() == ECMA48.MouseProtocol.OFF) {
+            if (mouse.isMouseWheelUp()) {
+                verticalDecrement();
                 return;
             }
+            if (mouse.isMouseWheelDown()) {
+                verticalIncrement();
+                return;
+            }
+        }
+        if (mouseOnEmulator(mouse)) {
+            mouse.setX(mouse.getX() - 1);
+            mouse.setY(mouse.getY() - 1);
+            emulator.addUserEvent(mouse);
+            readEmulatorState();
+            return;
         }
 
         // Emulator didn't consume it, pass it on
@@ -574,13 +612,11 @@ public class TTerminalWindow extends TScrollableWindow
         }
 
         if (mouseOnEmulator(mouse)) {
-            synchronized (emulator) {
-                mouse.setX(mouse.getX() - 1);
-                mouse.setY(mouse.getY() - 1);
-                emulator.mouse(mouse);
-                readEmulatorState();
-                return;
-            }
+            mouse.setX(mouse.getX() - 1);
+            mouse.setY(mouse.getY() - 1);
+            emulator.addUserEvent(mouse);
+            readEmulatorState();
+            return;
         }
 
         // Emulator didn't consume it, pass it on
@@ -601,13 +637,11 @@ public class TTerminalWindow extends TScrollableWindow
         }
 
         if (mouseOnEmulator(mouse)) {
-            synchronized (emulator) {
-                mouse.setX(mouse.getX() - 1);
-                mouse.setY(mouse.getY() - 1);
-                emulator.mouse(mouse);
-                readEmulatorState();
-                return;
-            }
+            mouse.setX(mouse.getX() - 1);
+            mouse.setY(mouse.getY() - 1);
+            emulator.addUserEvent(mouse);
+            readEmulatorState();
+            return;
         }
 
         // Emulator didn't consume it, pass it on
@@ -749,6 +783,10 @@ public class TTerminalWindow extends TScrollableWindow
 
         // Add shortcut text
         newStatusBar(i18n.getString("statusBarRunning"));
+
+        // Pass the correct text cell width/height to the emulator
+        emulator.setTextWidth(getScreen().getTextWidth());
+        emulator.setTextHeight(getScreen().getTextHeight());
     }
 
     /**
@@ -784,37 +822,6 @@ public class TTerminalWindow extends TScrollableWindow
         }
     }
 
-    /**
-     * Called by emulator when fresh data has come in.
-     */
-    public void displayChanged() {
-        getApplication().postEvent(new TMenuEvent(TMenu.MID_REPAINT));
-    }
-
-    /**
-     * Function to call to obtain the display width.
-     *
-     * @return the number of columns in the display
-     */
-    public int getDisplayWidth() {
-        if (ptypipe) {
-            return getWidth() - 2;
-        }
-        return 80;
-    }
-
-    /**
-     * Function to call to obtain the display height.
-     *
-     * @return the number of rows in the display
-     */
-    public int getDisplayHeight() {
-        if (ptypipe) {
-            return getHeight() - 2;
-        }
-        return 24;
-    }
-
     /**
      * Hook for subclasses to be notified of the shell termination.
      */
@@ -901,10 +908,8 @@ public class TTerminalWindow extends TScrollableWindow
      */
     private boolean mouseOnEmulator(final TMouseEvent mouse) {
 
-        synchronized (emulator) {
-            if (!emulator.isReading()) {
-                return false;
-            }
+        if (!emulator.isReading()) {
+            return false;
         }
 
         if ((mouse.getAbsoluteX() >= getAbsoluteX() + 1)
@@ -917,6 +922,20 @@ public class TTerminalWindow extends TScrollableWindow
         return false;
     }
 
+    /**
+     * Copy a display buffer.
+     *
+     * @param buffer the buffer to copy
+     * @return a deep copy of the buffer's data
+     */
+    private List<DisplayLine> copyBuffer(final List<DisplayLine> buffer) {
+        ArrayList<DisplayLine> result = new ArrayList<DisplayLine>(buffer.size());
+        for (DisplayLine line: buffer) {
+            result.add(new DisplayLine(line));
+        }
+        return result;
+    }
+
     /**
      * Draw glyphs for a double-width or double-height VT100 cell to two
      * screen cells.
@@ -929,19 +948,24 @@ public class TTerminalWindow extends TScrollableWindow
     private void putDoubleWidthCharXY(final DisplayLine line, final int x,
         final int y, final Cell cell) {
 
-        int textWidth = 16;
-        int textHeight = 20;
+        int textWidth = getScreen().getTextWidth();
+        int textHeight = getScreen().getTextHeight();
+        boolean cursorBlinkVisible = true;
 
         if (getScreen() instanceof SwingTerminal) {
             SwingTerminal terminal = (SwingTerminal) getScreen();
-
-            textWidth = terminal.getTextWidth();
-            textHeight = terminal.getTextHeight();
+            cursorBlinkVisible = terminal.getCursorBlinkVisible();
         } else if (getScreen() instanceof ECMA48Terminal) {
             ECMA48Terminal terminal = (ECMA48Terminal) getScreen();
 
-            textWidth = terminal.getTextWidth();
-            textHeight = terminal.getTextHeight();
+            if (!terminal.hasSixel()) {
+                // The backend does not have sixel support, draw this as text
+                // and bail out.
+                putCharXY(x, y, cell);
+                putCharXY(x + 1, y, ' ', cell);
+                return;
+            }
+            cursorBlinkVisible = blinkState;
         } else {
             // We don't know how to dray glyphs to this screen, draw them as
             // text and bail out.
@@ -951,47 +975,24 @@ public class TTerminalWindow extends TScrollableWindow
         }
 
         if ((textWidth != lastTextWidth) || (textHeight != lastTextHeight)) {
-            // Screen size has changed, reset all fonts.
-            setupFonts(textHeight);
+            // Screen size has changed, reset the font.
+            setupFont(textHeight);
             lastTextWidth = textWidth;
             lastTextHeight = textHeight;
         }
         assert (doubleFont != null);
 
-        BufferedImage image = null;
-
-        image = glyphCache.get(cell);
-        if (image == null) {
-            // Generate glyph and draw it to an image.
-            image = new BufferedImage(textWidth * 2, textHeight * 2,
-                BufferedImage.TYPE_INT_ARGB);
-            Graphics2D gr2 = image.createGraphics();
-            gr2.setFont(doubleFont);
-
-            // Draw the background rectangle, then the foreground character.
-            if (getScreen() instanceof ECMA48Terminal) {
-                // BUG: the background color is coming in the same as the
-                // foreground color.  For now, don't draw it.
-            } else {
-                gr2.setColor(SwingTerminal.attrToBackgroundColor(cell));
-                gr2.fillRect(0, 0, image.getWidth(), image.getHeight());
-            }
-            gr2.setColor(SwingTerminal.attrToForegroundColor(cell));
-            char [] chars = new char[1];
-            chars[0] = cell.getChar();
-            gr2.drawChars(chars, 0, 1, doubleTextAdjustX,
-                (textHeight * 2) - doubleMaxDescent + doubleTextAdjustY);
-
-            if (cell.isUnderline() && (line.getDoubleHeight() != 1)) {
-                gr2.fillRect(0, textHeight - 2, textWidth, 2);
-            }
-            gr2.dispose();
-
-            // Now save this generated image, using a new key that will not
-            // be mutated by invertCell().
-            Cell key = new Cell();
-            key.setTo(cell);
-            glyphCache.put(key, image);
+        BufferedImage image;
+        if (line.getDoubleHeight() == 1) {
+            // Double-height top half: don't draw the underline.
+            Cell newCell = new Cell();
+            newCell.setTo(cell);
+            newCell.setUnderline(false);
+            image = doubleFont.getImage(newCell, textWidth * 2, textHeight * 2,
+                cursorBlinkVisible);
+        } else {
+            image = doubleFont.getImage(cell,  textWidth * 2, textHeight * 2,
+                cursorBlinkVisible);
         }
 
         // Now that we have the double-wide glyph drawn, copy the right
@@ -1003,6 +1004,11 @@ public class TTerminalWindow extends TScrollableWindow
         right.setChar(' ');
         BufferedImage leftImage = null;
         BufferedImage rightImage = null;
+        /*
+        System.err.println("image " + image + " textWidth " + textWidth +
+            " textHeight " + textHeight);
+         */
+
         switch (line.getDoubleHeight()) {
         case 1:
             // Top half double height
@@ -1030,44 +1036,77 @@ public class TTerminalWindow extends TScrollableWindow
         }
         left.setImage(leftImage);
         right.setImage(rightImage);
+        // Since we have image data, ditch the character here.  Otherwise, a
+        // drawBoxShadow() over the terminal window will show the characters
+        // which looks wrong.
+        left.setChar(' ');
+        right.setChar(' ');
         putCharXY(x, y, left);
         putCharXY(x + 1, y, right);
     }
 
     /**
-     * Set up the single and double-width fonts.
+     * Set up the double-width font.
      *
      * @param fontSize the size of font to request for the single-width font.
      * The double-width font will be 2x this value.
      */
-    private void setupFonts(final int fontSize) {
-        try {
-            ClassLoader loader = Thread.currentThread().getContextClassLoader();
-            InputStream in = loader.getResourceAsStream(SwingTerminal.FONTFILE);
-            Font terminusRoot = Font.createFont(Font.TRUETYPE_FONT, in);
-            Font terminusDouble = terminusRoot.deriveFont(Font.PLAIN,
-                fontSize * 2);
-            doubleFont = terminusDouble;
-        } catch (java.awt.FontFormatException e) {
-            new TExceptionDialog(getApplication(), e);
-            doubleFont = new Font(Font.MONOSPACED, Font.PLAIN, fontSize * 2);
-        } catch (java.io.IOException e) {
-            new TExceptionDialog(getApplication(), e);
-            doubleFont = new Font(Font.MONOSPACED, Font.PLAIN, fontSize * 2);
+    private void setupFont(final int fontSize) {
+        doubleFont = GlyphMaker.getInstance(fontSize * 2);
+
+        // Special case: the ECMA48 backend needs to have a timer to drive
+        // its blink state.
+        if (getScreen() instanceof jexer.backend.ECMA48Terminal) {
+            if (!haveTimer) {
+                // Blink every 500 millis.
+                long millis = 500;
+                getApplication().addTimer(millis, true,
+                    new TAction() {
+                        public void DO() {
+                            blinkState = !blinkState;
+                            getApplication().doRepaint();
+                        }
+                    }
+                );
+                haveTimer = true;
+            }
         }
+    }
 
-        // Get font descent.
-        BufferedImage image = new BufferedImage(fontSize * 10, fontSize * 10,
-            BufferedImage.TYPE_INT_ARGB);
-        Graphics2D gr = image.createGraphics();
-        gr.setFont(doubleFont);
-        FontMetrics fm = gr.getFontMetrics();
-        doubleMaxDescent = fm.getMaxDescent();
+    // ------------------------------------------------------------------------
+    // DisplayListener --------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Called by emulator when fresh data has come in.
+     */
+    public void displayChanged() {
+        dirty = true;
+        getApplication().postEvent(new TMenuEvent(TMenu.MID_REPAINT));
+    }
 
-        gr.dispose();
+    /**
+     * Function to call to obtain the display width.
+     *
+     * @return the number of columns in the display
+     */
+    public int getDisplayWidth() {
+        if (ptypipe) {
+            return getWidth() - 2;
+        }
+        return 80;
+    }
 
-        // (Re)create the glyph cache.
-        glyphCache = new HashMap<Cell, BufferedImage>();
+    /**
+     * Function to call to obtain the display height.
+     *
+     * @return the number of rows in the display
+     */
+    public int getDisplayHeight() {
+        if (ptypipe) {
+            return getHeight() - 2;
+        }
+        return 24;
     }
 
 }