Merge pull request #488 from NuSkooler/bugfix/art_width

Fix to display ANSI files with implicit new lines on wide terminals

WHATSNEW.md

@@ -9,6 +9,7 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
     * Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.
 * CombatNet has shut down, so the module (`combatnet.js`) has been removed.
 * The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but check your `menu.hjson` entries if you see menu stack issues.
+* Art handling has been changed to respect the art width contained in SAUCE when present in the case where the terminal width is greater than the art width. This fixes art files that assume wrapping at 80 columns on wide (mostly new utf8) terminals.
 
 ## 0.0.13-beta
 * **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information.

core/ansi_escape_parser.js

@@ -37,6 +37,12 @@ function ANSIEscapeParser(options) {
     this.mciReplaceChar = miscUtil.valueWithDefault(options.mciReplaceChar, '');
     this.termHeight = miscUtil.valueWithDefault(options.termHeight, 25);
     this.termWidth = miscUtil.valueWithDefault(options.termWidth, 80);
+    this.breakWidth = this.termWidth;
+    // toNumber takes care of null, undefined etc as well.
+    let artWidth = _.toNumber(options.artWidth);
+    if(!(_.isNaN(artWidth)) && artWidth > 0 && artWidth < this.breakWidth) {
+        this.breakWidth = options.artWidth;
+    }
     this.trailingLF = miscUtil.valueWithDefault(options.trailingLF, 'default');
 
     this.row = Math.min(options?.startRow ?? 1, this.termHeight);
@@ -90,8 +96,8 @@ function ANSIEscapeParser(options) {
 
             switch (charCode) {
                 case CR:
-                    self.emit('literal', text.slice(start, pos));
-                    start = pos;
+                    self.emit('literal', text.slice(start, pos + 1));
+                    start = pos + 1;
 
                     self.column = 1;
 
@@ -105,8 +111,8 @@ function ANSIEscapeParser(options) {
                         self.column = 1;
                     }
 
-                    self.emit('literal', text.slice(start, pos));
-                    start = pos;
+                    self.emit('literal', text.slice(start, pos + 1));
+                    start = pos + 1;
 
                     self.row += 1;
 
@@ -114,13 +120,16 @@ function ANSIEscapeParser(options) {
                     break;
 
                 default:
-                    if (self.column === self.termWidth) {
+                    if (self.column === self.breakWidth) {
                         self.emit('literal', text.slice(start, pos + 1));
                         start = pos + 1;
 
+                        // If we hit breakWidth before termWidth then we need to force the terminal to go to the next line.
+                        if(self.column < self.termWidth) {
+                            self.emit('literal', '\r\n');
+                        }
                         self.column = 1;
                         self.row += 1;
-
                         self.positionUpdated();
                     } else {
                         self.column += 1;
@@ -135,7 +144,7 @@ function ANSIEscapeParser(options) {
         //
         //  Finalize this chunk
         //
-        if (self.column > self.termWidth) {
+        if (self.column > self.breakWidth) {
             self.column = 1;
             self.row += 1;
 

core/art.js

@@ -46,6 +46,16 @@ function getFontNameFromSAUCE(sauce) {
     }
 }
 
+function getWidthFromSAUCE(sauce) {
+    if (sauce.Character) {
+        let sauceWidth = _.toNumber(sauce.Character.characterWidth);
+        if(!(_.isNaN(sauceWidth)) && sauceWidth > 0) {
+            return sauceWidth;
+        }
+    }
+    return null;
+}
+
 function sliceAtEOF(data, eofMarker) {
     let eof = data.length;
     const stopPos = Math.max(data.length - 256, 0); //  256 = 2 * sizeof(SAUCE)
@@ -274,6 +284,7 @@ function display(client, art, options, cb) {
         mciReplaceChar: options.mciReplaceChar,
         termHeight: client.term.termHeight,
         termWidth: client.term.termWidth,
+        artWidth: getWidthFromSAUCE(options.sauce),
         trailingLF: options.trailingLF,
         startRow: options.startRow,
     });