X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fbackend%2FLogicalScreen.java;h=4e4aecca7a349eb999b83a9ef4bc71c229ff650a;hb=12b90437b5f22c2ae6e9b9b14c3b62b60f6143e5;hp=8432e4eae526f8a74f395303ebb8fbd3d5f3c09e;hpb=42873e30bf487bc0b695d60652dba44f82185dbb;p=fanfix.git diff --git a/src/jexer/backend/LogicalScreen.java b/src/jexer/backend/LogicalScreen.java index 8432e4e..4e4aecc 100644 --- a/src/jexer/backend/LogicalScreen.java +++ b/src/jexer/backend/LogicalScreen.java @@ -3,7 +3,7 @@ * * The MIT License (MIT) * - * Copyright (C) 2017 Kevin Lamonte + * Copyright (C) 2019 Kevin Lamonte * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -28,15 +28,23 @@ */ package jexer.backend; +import java.awt.image.BufferedImage; + +import jexer.backend.GlyphMaker; import jexer.bits.Cell; import jexer.bits.CellAttributes; import jexer.bits.GraphicsChars; +import jexer.bits.StringUtils; /** * A logical screen composed of a 2D array of Cells. */ public class LogicalScreen implements Screen { + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Width of the visible window. */ @@ -52,6 +60,115 @@ public class LogicalScreen implements Screen { */ private int offsetX; + /** + * Drawing offset for y. + */ + private int offsetY; + + /** + * Ignore anything drawn right of clipRight. + */ + private int clipRight; + + /** + * Ignore anything drawn below clipBottom. + */ + private int clipBottom; + + /** + * Ignore anything drawn left of clipLeft. + */ + private int clipLeft; + + /** + * Ignore anything drawn above clipTop. + */ + private int clipTop; + + /** + * The physical screen last sent out on flush(). + */ + protected Cell [][] physical; + + /** + * The logical screen being rendered to. + */ + protected Cell [][] logical; + + /** + * Set if the user explicitly wants to redraw everything starting with a + * ECMATerminal.clearAll(). + */ + protected boolean reallyCleared; + + /** + * If true, the cursor is visible and should be placed onscreen at + * (cursorX, cursorY) during a call to flushPhysical(). + */ + protected boolean cursorVisible; + + /** + * Cursor X position if visible. + */ + protected int cursorX; + + /** + * Cursor Y position if visible. + */ + protected int cursorY; + + /** + * The last used height of a character cell in pixels, only used for + * full-width chars. + */ + private int lastTextHeight = -1; + + /** + * The glyph drawer for full-width chars. + */ + private GlyphMaker glyphMaker = null; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Public constructor. Sets everything to not-bold, white-on-black. + */ + protected LogicalScreen() { + offsetX = 0; + offsetY = 0; + width = 80; + height = 24; + logical = null; + physical = null; + reallocate(width, height); + } + + // ------------------------------------------------------------------------ + // Screen ----------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Get the width of a character cell in pixels. + * + * @return the width in pixels of a character cell + */ + public int getTextWidth() { + // Default width is 16 pixels. + return 16; + } + + /** + * Get the height of a character cell in pixels. + * + * @return the height in pixels of a character cell + */ + public int getTextHeight() { + // Default height is 20 pixels. + return 20; + } + /** * Set drawing offset for x. * @@ -61,11 +178,6 @@ public class LogicalScreen implements Screen { this.offsetX = offsetX; } - /** - * Drawing offset for y. - */ - private int offsetY; - /** * Set drawing offset for y. * @@ -75,11 +187,6 @@ public class LogicalScreen implements Screen { this.offsetY = offsetY; } - /** - * Ignore anything drawn right of clipRight. - */ - private int clipRight; - /** * Get right drawing clipping boundary. * @@ -98,11 +205,6 @@ public class LogicalScreen implements Screen { this.clipRight = clipRight; } - /** - * Ignore anything drawn below clipBottom. - */ - private int clipBottom; - /** * Get bottom drawing clipping boundary. * @@ -121,11 +223,6 @@ public class LogicalScreen implements Screen { this.clipBottom = clipBottom; } - /** - * Ignore anything drawn left of clipLeft. - */ - private int clipLeft; - /** * Get left drawing clipping boundary. * @@ -144,11 +241,6 @@ public class LogicalScreen implements Screen { this.clipLeft = clipLeft; } - /** - * Ignore anything drawn above clipTop. - */ - private int clipTop; - /** * Get top drawing clipping boundary. * @@ -167,21 +259,6 @@ public class LogicalScreen implements Screen { this.clipTop = clipTop; } - /** - * The physical screen last sent out on flush(). - */ - protected Cell [][] physical; - - /** - * The logical screen being rendered to. - */ - protected Cell [][] logical; - - /** - * When true, logical != physical. - */ - protected volatile boolean dirty; - /** * Get dirty flag. * @@ -189,30 +266,21 @@ public class LogicalScreen implements Screen { * screen */ public final boolean isDirty() { - return dirty; - } - - /** - * Set if the user explicitly wants to redraw everything starting with a - * ECMATerminal.clearAll(). - */ - protected boolean reallyCleared; - - /** - * If true, the cursor is visible and should be placed onscreen at - * (cursorX, cursorY) during a call to flushPhysical(). - */ - protected boolean cursorVisible; - - /** - * Cursor X position if visible. - */ - protected int cursorX; + for (int x = 0; x < width; x++) { + for (int y = 0; y < height; y++) { + if (!logical[x][y].equals(physical[x][y])) { + return true; + } + if (logical[x][y].isBlink()) { + // Blinking screens are always dirty. There is + // opportunity for a Netscape blink tag joke here... + return true; + } + } + } - /** - * Cursor Y position if visible. - */ - protected int cursorY; + return false; + } /** * Get the attributes at one location. @@ -229,6 +297,21 @@ public class LogicalScreen implements Screen { return attr; } + /** + * Get the cell at one location. + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @return the character + attributes + */ + public Cell getCharXY(final int x, final int y) { + Cell cell = new Cell(); + if ((x >= 0) && (x < width) && (y >= 0) && (y < height)) { + cell.setTo(logical[x][y]); + } + return cell; + } + /** * Set the attributes at one location. * @@ -269,14 +352,14 @@ public class LogicalScreen implements Screen { } if ((X >= 0) && (X < width) && (Y >= 0) && (Y < height)) { - dirty = true; - logical[X][Y].setForeColor(attr.getForeColor()); - logical[X][Y].setBackColor(attr.getBackColor()); - logical[X][Y].setBold(attr.isBold()); - logical[X][Y].setBlink(attr.isBlink()); - logical[X][Y].setReverse(attr.isReverse()); - logical[X][Y].setUnderline(attr.isUnderline()); - logical[X][Y].setProtect(attr.isProtect()); + logical[X][Y].setTo(attr); + + // If this happens to be the cursor position, make the position + // dirty. + if ((cursorX == X) && (cursorY == Y)) { + physical[cursorX][cursorY].unset(); + unsetImageRow(cursorY); + } } } @@ -286,7 +369,7 @@ public class LogicalScreen implements Screen { * @param ch character to draw * @param attr attributes to use (bold, foreColor, backColor) */ - public final void putAll(final char ch, final CellAttributes attr) { + public final void putAll(final int ch, final CellAttributes attr) { for (int x = 0; x < width; x++) { for (int y = 0; y < height; y++) { @@ -303,7 +386,40 @@ public class LogicalScreen implements Screen { * @param ch character + attributes to draw */ public final void putCharXY(final int x, final int y, final Cell ch) { - putCharXY(x, y, ch.getChar(), ch); + if ((x < clipLeft) + || (x >= clipRight) + || (y < clipTop) + || (y >= clipBottom) + ) { + return; + } + + if ((StringUtils.width(ch.getChar()) == 2) && (!ch.isImage())) { + putFullwidthCharXY(x, y, ch); + return; + } + + int X = x + offsetX; + int Y = y + offsetY; + + // System.err.printf("putCharXY: %d, %d, %c\n", X, Y, ch); + + if ((X >= 0) && (X < width) && (Y >= 0) && (Y < height)) { + + // Do not put control characters on the display + if (!ch.isImage()) { + assert (ch.getChar() >= 0x20); + assert (ch.getChar() != 0x7F); + } + logical[X][Y].setTo(ch); + + // If this happens to be the cursor position, make the position + // dirty. + if ((cursorX == X) && (cursorY == Y)) { + physical[cursorX][cursorY].unset(); + unsetImageRow(cursorY); + } + } } /** @@ -314,7 +430,7 @@ public class LogicalScreen implements Screen { * @param ch character to draw * @param attr attributes to use (bold, foreColor, backColor) */ - public final void putCharXY(final int x, final int y, final char ch, + public final void putCharXY(final int x, final int y, final int ch, final CellAttributes attr) { if ((x < clipLeft) @@ -325,26 +441,31 @@ public class LogicalScreen implements Screen { return; } + if (StringUtils.width(ch) == 2) { + putFullwidthCharXY(x, y, ch, attr); + return; + } + int X = x + offsetX; int Y = y + offsetY; // System.err.printf("putCharXY: %d, %d, %c\n", X, Y, ch); if ((X >= 0) && (X < width) && (Y >= 0) && (Y < height)) { - dirty = true; // Do not put control characters on the display assert (ch >= 0x20); assert (ch != 0x7F); + logical[X][Y].setTo(attr); logical[X][Y].setChar(ch); - logical[X][Y].setForeColor(attr.getForeColor()); - logical[X][Y].setBackColor(attr.getBackColor()); - logical[X][Y].setBold(attr.isBold()); - logical[X][Y].setBlink(attr.isBlink()); - logical[X][Y].setReverse(attr.isReverse()); - logical[X][Y].setUnderline(attr.isUnderline()); - logical[X][Y].setProtect(attr.isProtect()); + + // If this happens to be the cursor position, make the position + // dirty. + if ((cursorX == X) && (cursorY == Y)) { + physical[cursorX][cursorY].unset(); + unsetImageRow(cursorY); + } } } @@ -355,8 +476,7 @@ public class LogicalScreen implements Screen { * @param y row coordinate. 0 is the top-most row. * @param ch character to draw */ - public final void putCharXY(final int x, final int y, final char ch) { - + public final void putCharXY(final int x, final int y, final int ch) { if ((x < clipLeft) || (x >= clipRight) || (y < clipTop) @@ -365,14 +485,25 @@ public class LogicalScreen implements Screen { return; } + if (StringUtils.width(ch) == 2) { + putFullwidthCharXY(x, y, ch); + return; + } + int X = x + offsetX; int Y = y + offsetY; // System.err.printf("putCharXY: %d, %d, %c\n", X, Y, ch); if ((X >= 0) && (X < width) && (Y >= 0) && (Y < height)) { - dirty = true; logical[X][Y].setChar(ch); + + // If this happens to be the cursor position, make the position + // dirty. + if ((cursorX == X) && (cursorY == Y)) { + physical[cursorX][cursorY].unset(); + unsetImageRow(cursorY); + } } } @@ -388,10 +519,11 @@ public class LogicalScreen implements Screen { final CellAttributes attr) { int i = x; - for (int j = 0; j < str.length(); j++) { - char ch = str.charAt(j); + for (int j = 0; j < str.length();) { + int ch = str.codePointAt(j); + j += Character.charCount(ch); putCharXY(i, y, ch, attr); - i++; + i += StringUtils.width(ch); if (i == width) { break; } @@ -409,10 +541,11 @@ public class LogicalScreen implements Screen { public final void putStringXY(final int x, final int y, final String str) { int i = x; - for (int j = 0; j < str.length(); j++) { - char ch = str.charAt(j); + for (int j = 0; j < str.length();) { + int ch = str.codePointAt(j); + j += Character.charCount(ch); putCharXY(i, y, ch); - i++; + i += StringUtils.width(ch); if (i == width) { break; } @@ -429,7 +562,7 @@ public class LogicalScreen implements Screen { * @param attr attributes to use (bold, foreColor, backColor) */ public final void vLineXY(final int x, final int y, final int n, - final char ch, final CellAttributes attr) { + final int ch, final CellAttributes attr) { for (int i = y; i < y + n; i++) { putCharXY(x, i, ch, attr); @@ -446,58 +579,13 @@ public class LogicalScreen implements Screen { * @param attr attributes to use (bold, foreColor, backColor) */ public final void hLineXY(final int x, final int y, final int n, - final char ch, final CellAttributes attr) { + final int ch, final CellAttributes attr) { for (int i = x; i < x + n; i++) { putCharXY(i, y, ch, attr); } } - /** - * Reallocate screen buffers. - * - * @param width new width - * @param height new height - */ - private synchronized void reallocate(final int width, final int height) { - if (logical != null) { - for (int row = 0; row < this.height; row++) { - for (int col = 0; col < this.width; col++) { - logical[col][row] = null; - } - } - logical = null; - } - logical = new Cell[width][height]; - if (physical != null) { - for (int row = 0; row < this.height; row++) { - for (int col = 0; col < this.width; col++) { - physical[col][row] = null; - } - } - physical = null; - } - physical = new Cell[width][height]; - - for (int row = 0; row < height; row++) { - for (int col = 0; col < width; col++) { - physical[col][row] = new Cell(); - logical[col][row] = new Cell(); - } - } - - this.width = width; - this.height = height; - - clipLeft = 0; - clipTop = 0; - clipRight = width; - clipBottom = height; - - reallyCleared = true; - dirty = true; - } - /** * Change the width. Everything on-screen will be destroyed and must be * redrawn. @@ -527,6 +615,14 @@ public class LogicalScreen implements Screen { */ public final void setDimensions(final int width, final int height) { reallocate(width, height); + resizeToScreen(); + } + + /** + * Resize the physical screen to match the logical screen dimensions. + */ + public void resizeToScreen() { + // Subclasses are expected to override this. } /** @@ -547,25 +643,11 @@ public class LogicalScreen implements Screen { return this.width; } - /** - * Public constructor. Sets everything to not-bold, white-on-black. - */ - protected LogicalScreen() { - offsetX = 0; - offsetY = 0; - width = 80; - height = 24; - logical = null; - physical = null; - reallocate(width, height); - } - /** * Reset screen to not-bold, white-on-black. Also flushes the offset and * clip variables. */ public final synchronized void reset() { - dirty = true; for (int row = 0; row < height; row++) { for (int col = 0; col < width; col++) { logical[col][row].reset(); @@ -593,22 +675,10 @@ public class LogicalScreen implements Screen { reset(); } - /** - * Clear the physical screen. - */ - public final void clearPhysical() { - dirty = true; - for (int row = 0; row < height; row++) { - for (int col = 0; col < width; col++) { - physical[col][row].reset(); - } - } - } - /** * Draw a box with a border and empty background. * - * @param left left column of box. 0 is the left-most row. + * @param left left column of box. 0 is the left-most column. * @param top top row of the box. 0 is the top-most row. * @param right right column of box * @param bottom bottom row of the box @@ -625,7 +695,7 @@ public class LogicalScreen implements Screen { /** * Draw a box with a border and empty background. * - * @param left left column of box. 0 is the left-most row. + * @param left left column of box. 0 is the left-most column. * @param top top row of the box. 0 is the top-most row. * @param right right column of box * @param bottom bottom row of the box @@ -710,7 +780,7 @@ public class LogicalScreen implements Screen { /** * Draw a box shadow. * - * @param left left column of box. 0 is the left-most row. + * @param left left column of box. 0 is the left-most column. * @param top top row of the box. 0 is the top-most row. * @param right right column of box * @param bottom bottom row of the box @@ -727,19 +797,36 @@ public class LogicalScreen implements Screen { // Shadows do not honor clipping but they DO honor offset. int oldClipRight = clipRight; int oldClipBottom = clipBottom; - /* - clipRight = boxWidth + 2; - clipBottom = boxHeight + 1; - */ - clipRight = width; - clipBottom = height; + // When offsetX or offsetY go negative, we need to increase the clip + // bounds. + clipRight = width - offsetX; + clipBottom = height - offsetY; for (int i = 0; i < boxHeight; i++) { - putAttrXY(boxLeft + boxWidth, boxTop + 1 + i, shadowAttr); - putAttrXY(boxLeft + boxWidth + 1, boxTop + 1 + i, shadowAttr); + Cell cell = getCharXY(offsetX + boxLeft + boxWidth, + offsetY + boxTop + 1 + i); + if (cell.getWidth() == Cell.Width.SINGLE) { + putAttrXY(boxLeft + boxWidth, boxTop + 1 + i, shadowAttr); + } else { + putCharXY(boxLeft + boxWidth, boxTop + 1 + i, ' ', shadowAttr); + } + cell = getCharXY(offsetX + boxLeft + boxWidth + 1, + offsetY + boxTop + 1 + i); + if (cell.getWidth() == Cell.Width.SINGLE) { + putAttrXY(boxLeft + boxWidth + 1, boxTop + 1 + i, shadowAttr); + } else { + putCharXY(boxLeft + boxWidth + 1, boxTop + 1 + i, ' ', + shadowAttr); + } } for (int i = 0; i < boxWidth; i++) { - putAttrXY(boxLeft + 2 + i, boxTop + boxHeight, shadowAttr); + Cell cell = getCharXY(offsetX + boxLeft + 2 + i, + offsetY + boxTop + boxHeight); + if (cell.getWidth() == Cell.Width.SINGLE) { + putAttrXY(boxLeft + 2 + i, boxTop + boxHeight, shadowAttr); + } else { + putCharXY(boxLeft + 2 + i, boxTop + boxHeight, ' ', shadowAttr); + } } clipRight = oldClipRight; clipBottom = oldClipBottom; @@ -758,6 +845,15 @@ public class LogicalScreen implements Screen { * @param y row coordinate to put the cursor on */ public void putCursor(final boolean visible, final int x, final int y) { + if ((cursorY >= 0) + && (cursorX >= 0) + && (cursorY <= height - 1) + && (cursorX <= width - 1) + ) { + // Make the current cursor position dirty + physical[cursorX][cursorY].unset(); + unsetImageRow(cursorY); + } cursorVisible = visible; cursorX = x; @@ -771,6 +867,33 @@ public class LogicalScreen implements Screen { cursorVisible = false; } + /** + * Get the cursor visibility. + * + * @return true if the cursor is visible + */ + public boolean isCursorVisible() { + return cursorVisible; + } + + /** + * Get the cursor X position. + * + * @return the cursor x column position + */ + public int getCursorX() { + return cursorX; + } + + /** + * Get the cursor Y position. + * + * @return the cursor y row position + */ + public int getCursorY() { + return cursorY; + } + /** * Set the window title. Default implementation does nothing. * @@ -778,4 +901,145 @@ public class LogicalScreen implements Screen { */ public void setTitle(final String title) {} + // ------------------------------------------------------------------------ + // LogicalScreen ---------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Reallocate screen buffers. + * + * @param width new width + * @param height new height + */ + private synchronized void reallocate(final int width, final int height) { + if (logical != null) { + for (int row = 0; row < this.height; row++) { + for (int col = 0; col < this.width; col++) { + logical[col][row] = null; + } + } + logical = null; + } + logical = new Cell[width][height]; + if (physical != null) { + for (int row = 0; row < this.height; row++) { + for (int col = 0; col < this.width; col++) { + physical[col][row] = null; + } + } + physical = null; + } + physical = new Cell[width][height]; + + for (int row = 0; row < height; row++) { + for (int col = 0; col < width; col++) { + physical[col][row] = new Cell(); + logical[col][row] = new Cell(); + } + } + + this.width = width; + this.height = height; + + clipLeft = 0; + clipTop = 0; + clipRight = width; + clipBottom = height; + + reallyCleared = true; + } + + /** + * Clear the physical screen. + */ + public final void clearPhysical() { + for (int row = 0; row < height; row++) { + for (int col = 0; col < width; col++) { + physical[col][row].unset(); + } + } + } + + /** + * Unset every image cell on one row of the physical screen, forcing + * images on that row to be redrawn. + * + * @param y row coordinate. 0 is the top-most row. + */ + public final void unsetImageRow(final int y) { + if ((y < 0) || (y >= height)) { + return; + } + for (int x = 0; x < width; x++) { + if (logical[x][y].isImage()) { + physical[x][y].unset(); + } + } + } + + /** + * Render one fullwidth cell. + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param cell the cell to draw + */ + public final void putFullwidthCharXY(final int x, final int y, + final Cell cell) { + + int cellWidth = getTextWidth(); + int cellHeight = getTextHeight(); + + if (lastTextHeight != cellHeight) { + glyphMaker = GlyphMaker.getInstance(cellHeight); + lastTextHeight = cellHeight; + } + BufferedImage image = glyphMaker.getImage(cell, cellWidth * 2, + cellHeight); + BufferedImage leftImage = image.getSubimage(0, 0, cellWidth, + cellHeight); + BufferedImage rightImage = image.getSubimage(cellWidth, 0, cellWidth, + cellHeight); + + Cell left = new Cell(cell); + left.setImage(leftImage); + left.setWidth(Cell.Width.LEFT); + putCharXY(x, y, left); + + Cell right = new Cell(cell); + right.setImage(rightImage); + right.setWidth(Cell.Width.RIGHT); + putCharXY(x + 1, y, right); + } + + /** + * Render one fullwidth character with attributes. + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param ch character to draw + * @param attr attributes to use (bold, foreColor, backColor) + */ + public final void putFullwidthCharXY(final int x, final int y, + final int ch, final CellAttributes attr) { + + Cell cell = new Cell(ch, attr); + putFullwidthCharXY(x, y, cell); + } + + /** + * Render one fullwidth character with attributes. + * + * @param x column coordinate. 0 is the left-most column. + * @param y row coordinate. 0 is the top-most row. + * @param ch character to draw + */ + public final void putFullwidthCharXY(final int x, final int y, + final int ch) { + + Cell cell = new Cell(ch); + cell.setAttr(getAttrXY(x, y)); + putFullwidthCharXY(x, y, cell); + } + }