From 95f332f3d2cc4320c2714e67cb72cc7782868843 Mon Sep 17 00:00:00 2001
From: Jeremy Albright <myrlin1@gmail.com>
Date: Wed, 27 Nov 2019 11:02:02 -0900
Subject: [PATCH] readline: promote _getCursorPos to public api

Alias _getCursorPos() = getCursorPos() for backwards
compatibility.

Refs: https://github.com/nodejs/node/issues/30347

PR-URL: https://github.com/nodejs/node/pull/30687
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
---
 doc/api/readline.md                      | 13 +++++
 lib/readline.js                          | 11 ++--
 test/parallel/test-readline-interface.js | 68 ++++++++++++------------
 test/parallel/test-readline-position.js  |  2 +-
 4 files changed, 54 insertions(+), 40 deletions(-)

diff --git a/doc/api/readline.md b/doc/api/readline.md
index 9fd8f1f1ecacc1..c6d468156af3fb 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -398,6 +398,19 @@ reading input from a TTY stream.  The position of cursor determines the
 portion of the input string that will be modified as input is processed,
 as well as the column where the terminal caret will be rendered.
 
+### `rl.getCursorPos()`
+<!-- YAML
+added: REPLACEME
+-->
+
+* Returns: {Object}
+  * `rows` {number} the row of the prompt the cursor currently lands on
+  * `cols` {number} the screen column the cursor currently lands on
+
+Returns the real position of the cursor in relation to the input
+prompt + string.  Long input (wrapping) strings, as well as multiple
+line prompts are included in the calculations.
+
 ## `readline.clearLine(stream, dir[, callback])`
 <!-- YAML
 added: v0.7.7
diff --git a/lib/readline.js b/lib/readline.js
index 35ed6a4e29d895..3e4f3cf42d3d96 100644
--- a/lib/readline.js
+++ b/lib/readline.js
@@ -366,7 +366,7 @@ Interface.prototype._refreshLine = function() {
   const lineRows = dispPos.rows;
 
   // cursor position
-  const cursorPos = this._getCursorPos();
+  const cursorPos = this.getCursorPos();
 
   // First move to the bottom of the current line, based on cursor pos
   const prevRows = this.prevRows || 0;
@@ -482,7 +482,7 @@ Interface.prototype._insertString = function(c) {
     this.line += c;
     this.cursor += c.length;
 
-    if (this._getCursorPos().cols === 0) {
+    if (this.getCursorPos().cols === 0) {
       this._refreshLine();
     } else {
       this._writeToOutput(c);
@@ -761,7 +761,7 @@ Interface.prototype._getDisplayPos = function(str) {
 
 
 // Returns current cursor's position and line
-Interface.prototype._getCursorPos = function() {
+Interface.prototype.getCursorPos = function() {
   const columns = this.columns;
   const strBeforeCursor = this._prompt + this.line.substring(0, this.cursor);
   const dispPos = this._getDisplayPos(
@@ -778,20 +778,21 @@ Interface.prototype._getCursorPos = function() {
   }
   return { cols: cols, rows: rows };
 };
+Interface.prototype._getCursorPos = Interface.prototype.getCursorPos;
 
 
 // This function moves cursor dx places to the right
 // (-dx for left) and refreshes the line if it is needed
 Interface.prototype._moveCursor = function(dx) {
   const oldcursor = this.cursor;
-  const oldPos = this._getCursorPos();
+  const oldPos = this.getCursorPos();
   this.cursor += dx;
 
   // bounds check
   if (this.cursor < 0) this.cursor = 0;
   else if (this.cursor > this.line.length) this.cursor = this.line.length;
 
-  const newPos = this._getCursorPos();
+  const newPos = this.getCursorPos();
 
   // Check if cursors are in the same line
   if (oldPos.rows === newPos.rows) {
diff --git a/test/parallel/test-readline-interface.js b/test/parallel/test-readline-interface.js
index 8c7fb1a0f28090..08d3b363ddc4fa 100644
--- a/test/parallel/test-readline-interface.js
+++ b/test/parallel/test-readline-interface.js
@@ -570,7 +570,7 @@ function isWarned(emitter) {
       rli.question(expectedLines[0], function() {
         rli.close();
       });
-      const cursorPos = rli._getCursorPos();
+      const cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, expectedLines[0].length);
       rli.close();
@@ -586,7 +586,7 @@ function isWarned(emitter) {
       rli.question(expectedLines.join('\n'), function() {
         rli.close();
       });
-      const cursorPos = rli._getCursorPos();
+      const cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, expectedLines.length - 1);
       assert.strictEqual(cursorPos.cols, expectedLines.slice(-1)[0].length);
       rli.close();
@@ -603,11 +603,11 @@ function isWarned(emitter) {
       });
       fi.emit('data', 'the quick brown fox');
       fi.emit('keypress', '.', { ctrl: true, name: 'a' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       fi.emit('keypress', '.', { ctrl: true, name: 'e' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
       rli.close();
@@ -623,28 +623,28 @@ function isWarned(emitter) {
         terminal: terminal
       });
       fi.emit('data', 'the quick brown fox');
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
 
       // Back one character
       fi.emit('keypress', '.', { ctrl: true, name: 'b' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 18);
       // Back one character
       fi.emit('keypress', '.', { ctrl: true, name: 'b' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 17);
       // Forward one character
       fi.emit('keypress', '.', { ctrl: true, name: 'f' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 18);
       // Forward one character
       fi.emit('keypress', '.', { ctrl: true, name: 'f' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
       rli.close();
@@ -663,13 +663,13 @@ function isWarned(emitter) {
 
       // Move left one character/code point
       fi.emit('keypress', '.', { name: 'left' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
 
       // Move right one character/code point
       fi.emit('keypress', '.', { name: 'right' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       if (common.hasIntl) {
         assert.strictEqual(cursorPos.cols, 2);
@@ -697,12 +697,12 @@ function isWarned(emitter) {
 
       // Move left one character/code point
       fi.emit('keypress', '.', { name: 'left' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
 
       fi.emit('data', '🐕');
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
 
       if (common.hasIntl) {
@@ -733,7 +733,7 @@ function isWarned(emitter) {
 
       // Move left one character/code point
       fi.emit('keypress', '.', { name: 'right' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       if (common.hasIntl) {
         assert.strictEqual(cursorPos.cols, 2);
@@ -744,7 +744,7 @@ function isWarned(emitter) {
       }
 
       fi.emit('data', '🐕');
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       if (common.hasIntl) {
         assert.strictEqual(cursorPos.cols, 4);
@@ -770,19 +770,19 @@ function isWarned(emitter) {
       });
       fi.emit('data', 'the quick brown fox');
       fi.emit('keypress', '.', { ctrl: true, name: 'left' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 16);
       fi.emit('keypress', '.', { meta: true, name: 'b' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 10);
       fi.emit('keypress', '.', { ctrl: true, name: 'right' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 16);
       fi.emit('keypress', '.', { meta: true, name: 'f' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
       rli.close();
@@ -884,13 +884,13 @@ function isWarned(emitter) {
         terminal: terminal
       });
       fi.emit('data', 'the quick brown fox');
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
 
       // Delete left character
       fi.emit('keypress', '.', { ctrl: true, name: 'h' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 18);
       rli.on('line', common.mustCall((line) => {
@@ -910,7 +910,7 @@ function isWarned(emitter) {
         terminal: terminal
       });
       fi.emit('data', '💻');
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       if (common.hasIntl) {
         assert.strictEqual(cursorPos.cols, 2);
@@ -919,7 +919,7 @@ function isWarned(emitter) {
       }
       // Delete left character
       fi.emit('keypress', '.', { ctrl: true, name: 'h' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       rli.on('line', common.mustCall((line) => {
@@ -942,13 +942,13 @@ function isWarned(emitter) {
 
       // Go to the start of the line
       fi.emit('keypress', '.', { ctrl: true, name: 'a' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
 
       // Delete right character
       fi.emit('keypress', '.', { ctrl: true, name: 'd' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       rli.on('line', common.mustCall((line) => {
@@ -971,13 +971,13 @@ function isWarned(emitter) {
 
       // Go to the start of the line
       fi.emit('keypress', '.', { ctrl: true, name: 'a' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
 
       // Delete right character
       fi.emit('keypress', '.', { ctrl: true, name: 'd' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       rli.on('line', common.mustCall((line) => {
@@ -997,13 +997,13 @@ function isWarned(emitter) {
         terminal: terminal
       });
       fi.emit('data', 'the quick brown fox');
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 19);
 
       // Delete from current to start of line
       fi.emit('keypress', '.', { ctrl: true, shift: true, name: 'backspace' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       rli.on('line', common.mustCall((line) => {
@@ -1026,13 +1026,13 @@ function isWarned(emitter) {
 
       // Go to the start of the line
       fi.emit('keypress', '.', { ctrl: true, name: 'a' });
-      let cursorPos = rli._getCursorPos();
+      let cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
 
       // Delete from current to end of line
       fi.emit('keypress', '.', { ctrl: true, shift: true, name: 'delete' });
-      cursorPos = rli._getCursorPos();
+      cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 0);
       rli.on('line', common.mustCall((line) => {
@@ -1053,7 +1053,7 @@ function isWarned(emitter) {
       });
       fi.columns = 10;
       fi.emit('data', 'multi-line text');
-      const cursorPos = rli._getCursorPos();
+      const cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 1);
       assert.strictEqual(cursorPos.cols, 5);
       rli.close();
@@ -1070,7 +1070,7 @@ function isWarned(emitter) {
       });
       fi.columns = 10;
       fi.emit('data', 't');
-      const cursorPos = rli._getCursorPos();
+      const cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 4);
       assert.strictEqual(cursorPos.cols, 3);
       rli.close();
@@ -1088,7 +1088,7 @@ function isWarned(emitter) {
       const lines = ['line 1', 'line 2', 'line 3'];
       fi.emit('data', lines.join('\n'));
       fi.emit('keypress', '.', { ctrl: true, name: 'l' });
-      const cursorPos = rli._getCursorPos();
+      const cursorPos = rli.getCursorPos();
       assert.strictEqual(cursorPos.rows, 0);
       assert.strictEqual(cursorPos.cols, 6);
       rli.on('line', common.mustCall((line) => {
diff --git a/test/parallel/test-readline-position.js b/test/parallel/test-readline-position.js
index 60ef476afe9ae3..88e4d6104b5047 100644
--- a/test/parallel/test-readline-position.js
+++ b/test/parallel/test-readline-position.js
@@ -37,7 +37,7 @@ const ctrlU = { ctrl: true, name: 'u' };
 
   for (const [cursor, string] of tests) {
     rl.write(string);
-    assert.strictEqual(rl._getCursorPos().cols, cursor);
+    assert.strictEqual(rl.getCursorPos().cols, cursor);
     rl.write(null, ctrlU);
   }
 }