2296. Design a Text Editor

HardStackDesignLinked ListStringDoubly-Linked ListSimulation
Leetcode Link

Problem Description

The problem requires us to design a simple text editor with basic functionalities such as adding text, deleting text, and moving the cursor left or right. Unlike standard text editors that deal with complex rendering and formatting, our task is to simulate how the internal state of the text editor changes as these operations are performed. The editor will keep track of the cursor position and allow the following actions:

  • Add text: Insert a given string of text where the cursor is currently positioned. After the text is added, the cursor should be at the end of the newly added text.
  • Delete text: Remove a specified number of characters from the text, directly to the left of the cursor position. The function should return the actual number of characters deleted, which could be less than the requested if there are not enough characters.
  • Move cursor left: Shift the cursor to the left 'k' positions. If there aren't 'k' characters to the left of the cursor, move the cursor as far as possible. After moving, the function should return a string containing the last 10 (or fewer, if less than 10 characters are available) characters to the left of the cursor.
  • Move cursor right: Shift the cursor to the right 'k' positions. Similarly, this should also return the last 10 (or fewer) characters to the left of the text where the cursor is now placed after the movement.

The cursor is limited to the bounds of the current text content, meaning it cannot move further left than the first character or further right than the last character of the text.

Intuition

A straightforward approach to solve this problem is to use two stacks—a "left" stack to represent the text before the cursor and a "right" stack to represent the text after the cursor. This method leverages the properties of stacks to manage the characters efficiently in both directions relative to the cursor:

  1. When we add text, we push the new characters to the "left" stack, as they are added where the cursor currently is, which is at the end of the existing text in the "left" stack.
  2. When performing the delete operation, we pop characters from the "left" stack, simulating the deletion of characters to the left of the cursor.
  3. To move the cursor to the left, we pop characters from the "left" stack and push them onto the "right" stack, effectively moving the cursor backwards. The last 10 characters of the "left" stack are then concatenated into a string and returned.
  4. To move the cursor to the right, we pop characters from the "right" stack and push them onto the "left" stack, like 'undoing' a leftward cursor move. Again, we concatenate and return the last 10 characters of the "left" stack.

Through the push and pop operations of stacks, we can control the text before and after the cursor efficiently, and maintain an accurate picture of what the characters around the cursor would be after each operation.

Learn more about Stack and Linked List patterns.

Not Sure What to Study? Take the 2-min Quiz to Find Your Missing Piece:

Suppose k is a very large integer(2^64). Which of the following is the largest as n grows to infinity?

Solution Approach

The solution approach for the text editor design involves using two stacks, referred to in the code as self.left and self.right, to hold characters on each side of the cursor. Here's a detailed explanation of how each method in the TextEditor class works:

  • Constructor (__init__): Initializes two lists, self.left and self.right, which act as stacks. These stacks are empty at the start, representing an empty text state with the cursor at the initial position.

  • Add text (addText): Takes a string text as input and extends the self.left stack with the new characters. This simulates typing at the cursor's position, as characters are appended where the cursor is. After adding, the cursor ends up to the right of the new text, naturally.

  • Delete text (deleteText): Takes an integer k representing the number of characters to delete. The actual number of deletions cannot exceed the number of characters in self.left, so min(k, len(self.left)) is calculated to determine the true number of deletible characters. The method then pops these characters from the self.left stack and returns the count of the deleted characters. Each pop removes a character on the left of the cursor, mimicking a backspace operation.

  • Move cursor left (cursorLeft): Transfers k characters from the self.left stack to the self.right stack, if available, moving the cursor left k times. If there are fewer than k characters, it moves the cursor to the start. It then returns a string composed of the last 10 (or fewer if less than 10 are available) characters of the self.left stack, reflecting the text immediately left of the cursor after the move.

  • Move cursor right (cursorRight): Moves the cursor to the right by transferring k characters from the self.right stack back to the self.left stack, simulating a forward cursor movement. As with the left move, it only moves as far as characters exist in self.right. It then returns a string of up to the last 10 characters from the self.left stack.

These stack operations (push and pop) allow the text editor to efficiently mimic the addition, deletion, and cursor movement actions. Stacks are chosen due to their LIFO (last in, first out) nature, which perfectly suits the operations we need to simulate for this text editor design.

Discover Your Strengths and Weaknesses: Take Our 2-Minute Quiz to Tailor Your Study Plan:

What is the running time of the following code?

1int sqrt(int n) {
2  for (int guess = 1; guess * guess <= n; guess++) {
3    if (guess * guess == n) {
4      return guess;
5    }
6  }
7  return -1;
8}

Example Walkthrough

Let's consider we are using the TextEditor class described above to perform a series of operations on our text editor. Suppose we start with an empty text field, and we want to perform the following actions:

  1. Add text "hello".
  2. Move cursor left by 2 positions.
  3. Add text "X".
  4. Delete text of 1 character.
  5. Move cursor right by 1 position.

Here's how the TextEditor class handles these operations:

  • Initial State: (Cursor at the start) left = [], right = []

  • Add text "hello": The addText method appends each character of "hello" to self.left. left = ['h', 'e', 'l', 'l', 'o'], right = [] (Cursor is now at the end of "hello")

  • Move cursor left by 2: The cursorLeft(2) method moves the cursor 2 positions to the left. It pops two characters from self.left and pushes them into self.right. left = ['h', 'e', 'l'], right = ['l', 'o'] Last 10 characters of the left stack: "hel"

  • Add text "X": The addText method adds the "X" character to self.left. left = ['h', 'e', 'l', 'X'], right = ['l', 'o'] (Cursor is now after "X")

  • Delete text of 1 character: The deleteText(1) method deletes 1 character from the left of the cursor by popping from self.left. left = ['h', 'e', 'l'], right = ['l', 'o'] 1 character was deleted.

  • Move cursor right by 1: The cursorRight(1) method moves the cursor 1 position to the right. It pops one character from self.right and pushes it into self.left. left = ['h', 'e', 'l', 'l'], right = ['o'] Last 10 characters of the left stack: "hell"

After all these operations, the state of the text editor and stacks are as follows:
Text Content: "hell|o" (with the cursor positioned at "|")
left = ['h', 'e', 'l', 'l']
right = ['o']

Each of these operations efficiently alters the state of the text editor by using the two-stack approach while keeping track of the cursor's position, as described in the solution approach.

Solution Implementation

1class TextEditor:
2    def __init__(self):
3        # Stack for the text on the left side of the cursor
4        self.left_stack = []  
5        # Stack for the text on the right side of the cursor
6        self.right_stack = []
7
8    def addText(self, text: str) -> None:
9        """Add text to the left side of the cursor."""
10        # Extend the left stack with characters from the text
11        self.left_stack.extend(text)  
12
13    def deleteText(self, k: int) -> int:
14        """Delete 'k' characters to the left of the cursor."""
15        # Ensure 'k' does not exceed the number of characters on the left
16        k = min(k, len(self.left_stack))  
17        # Pop 'k' characters from the left stack
18        for _ in range(k):
19            self.left_stack.pop()  
20        # Return the number of characters deleted
21        return k  
22
23    def cursorLeft(self, k: int) -> str:
24        """Move the cursor 'k' positions to the left."""
25        # Ensure 'k' does not exceed the number of characters on the left
26        k = min(k, len(self.left_stack))  
27        # Move 'k' characters from the left stack to the right stack
28        for _ in range(k):  
29            self.right_stack.append(self.left_stack.pop()) 
30        # Return the last 10 characters on the left stack or all if less than 10
31        return ''.join(self.left_stack[-10:])  
32
33    def cursorRight(self, k: int) -> str:
34        """Move the cursor 'k' positions to the right."""
35        # Ensure 'k' does not exceed the number of characters on the right
36        k = min(k, len(self.right_stack))  
37        # Move 'k' characters from the right stack to the left stack
38        for _ in range(k):  
39            self.left_stack.append(self.right_stack.pop()) 
40        # Return the last 10 characters on the left stack or all if less than 10
41        return ''.join(self.left_stack[-10:])  
42
43
44# Example usage:
45# Initialize the text editor
46text_editor = TextEditor()
47# Add text
48text_editor.addText("hello")
49# Delete 3 characters
50deleted_chars = text_editor.deleteText(3)
51# Move cursor 2 positions to the left
52display_text = text_editor.cursorLeft(2)
53# Move cursor 2 positions to the right
54display_text = text_editor.cursorRight(2)
55
1class TextEditor {
2    private StringBuilder leftText = new StringBuilder();
3    private StringBuilder rightText = new StringBuilder();
4
5    // Constructor for the text editor.
6    public TextEditor() {
7        // Intentionally left empty.
8    }
9
10    // Adds the given text to the end of the current cursor position.
11    public void addText(String text) {
12        leftText.append(text);
13    }
14
15    // Deletes the 'k' characters before the cursor and returns the count of characters deleted.
16    public int deleteText(int k) {
17        int actualDeleteCount = Math.min(k, leftText.length());
18        leftText.setLength(leftText.length() - actualDeleteCount);
19        return actualDeleteCount;
20    }
21
22    // Moves the cursor to the left by 'k' positions and returns the text within 10 positions to the left of the cursor.
23    public String cursorLeft(int k) {
24        int actualMoveCount = Math.min(k, leftText.length());
25        for (int i = 0; i < actualMoveCount; ++i) {
26            rightText.append(leftText.charAt(leftText.length() - 1));
27            leftText.deleteCharAt(leftText.length() - 1);
28        }
29        // Get the substring of the last 10 characters or entire text if it's shorter.
30        return leftText.substring(Math.max(leftText.length() - 10, 0));
31    }
32
33    // Moves the cursor to the right by 'k' positions and returns the text within 10 positions to the left of the cursor.
34    public String cursorRight(int k) {
35        int actualMoveCount = Math.min(k, rightText.length());
36        for (int i = 0; i < actualMoveCount; ++i) {
37            char ch = rightText.charAt(rightText.length() - 1);
38            leftText.append(ch);
39            rightText.deleteCharAt(rightText.length() - 1);
40        }
41        // Get the substring of the last 10 characters or entire text if it's shorter.
42        return leftText.substring(Math.max(leftText.length() - 10, 0));
43    }
44}
45
46/*
47 * Usage of TextEditor:
48 * TextEditor textEditor = new TextEditor();
49 * textEditor.addText(text);  // Adds text at the current cursor position.
50 * int deletedCount = textEditor.deleteText(k);  // Deletes 'k' characters from the left of the cursor.
51 * String leftText = textEditor.cursorLeft(k);  // Moves cursor 'k' positions to the left.
52 * String rightText = textEditor.cursorRight(k);  // Moves cursor 'k' positions to the right.
53 */
54
1#include <string>
2#include <algorithm>
3
4using std::string;
5using std::min;
6using std::max;
7
8class TextEditor {
9public:
10    // Constructor initializes an empty text editor
11    TextEditor() {
12        // Both strings are initially empty
13        textLeftOfCursor = "";
14        textRightOfCursor = "";
15    }
16
17    // Function to add text directly before the cursor's current position
18    void addText(string text) {
19        textLeftOfCursor += text; // Append the text to the left part (before cursor)
20    }
21
22    // Function to delete 'k' characters before the cursor's position
23    int deleteText(int k) {
24        int actualDeleteCount = min(k, static_cast<int>(textLeftOfCursor.size()));
25        textLeftOfCursor.resize(textLeftOfCursor.size() - actualDeleteCount); // Delete characters from the end
26        return actualDeleteCount; // Return the number of characters that were actually deleted
27    }
28
29    // Function to move the cursor 'k' positions to the left, returning at most 10 characters before the cursor
30    string cursorLeft(int k) {
31        k = min(k, static_cast<int>(textLeftOfCursor.size())); // Bound k to the number of characters available to move
32        while (k--) {
33            textRightOfCursor += textLeftOfCursor.back(); // Move last character of left text to the start of right text
34            textLeftOfCursor.pop_back(); // Remove the moved character from the left text
35        }
36
37        // Return at most 10 characters of the left text, truncating from the front if needed
38        return textLeftOfCursor.substr(max(0, static_cast<int>(textLeftOfCursor.size()) - 10));
39    }
40
41    // Function to move the cursor 'k' positions to the right, returning at most 10 characters before the cursor
42    string cursorRight(int k) {
43        k = min(k, static_cast<int>(textRightOfCursor.size())); // Bound k to the number of characters available to move
44        while (k--) {
45            textLeftOfCursor += textRightOfCursor.back(); // Move last character of right text to the end of left text
46            textRightOfCursor.pop_back(); // Remove the moved character from the right text
47        }
48
49        // Return at most 10 characters of the left text, truncating from the front if needed
50        return textLeftOfCursor.substr(max(0, static_cast<int>(textLeftOfCursor.size()) - 10));
51    }
52
53private:
54    string textLeftOfCursor;   // Stores the text left of the cursor
55    string textRightOfCursor;  // Stores the text right of the cursor
56};
57
58// Example of how to use the TextEditor class
59/*
60TextEditor* editor = new TextEditor();
61editor->addText("hello");
62int deletedChars = editor->deleteText(3);
63string leftSubstring = editor->cursorLeft(2);
64string rightSubstring = editor->cursorRight(2);
65delete editor; // Release the allocated memory
66*/
67
1// Initialize two strings to simulate the text to the left and right of the cursor.
2let textLeftOfCursor: string = "";
3let textRightOfCursor: string = "";
4
5// Function to add text directly before the cursor's current position.
6function addText(text: string): void {
7    // Append the text to the left part (before cursor).
8    textLeftOfCursor += text;
9}
10
11// Function to delete 'k' characters before the cursor's position.
12function deleteText(k: number): number {
13    // Determine the actual number of characters that can be deleted.
14    const actualDeleteCount: number = Math.min(k, textLeftOfCursor.length);
15    // Delete the specified number of characters from the end.
16    textLeftOfCursor = textLeftOfCursor.slice(0, -actualDeleteCount);
17    // Return the number of characters that were actually deleted.
18    return actualDeleteCount;
19}
20
21// Function to move the cursor 'k' positions to the left, returning at most 10 characters before the cursor.
22function cursorLeft(k: number): string {
23    // Bound 'k' to the number of characters available to move left.
24    k = Math.min(k, textLeftOfCursor.length);
25    while (k-- > 0) {
26        // Move the last character of the left text to the start of the right text.
27        textRightOfCursor = textLeftOfCursor.charAt(textLeftOfCursor.length - 1) + textRightOfCursor;
28        // Remove the moved character from the left text.
29        textLeftOfCursor = textLeftOfCursor.slice(0, -1);
30    }
31    // Return at most 10 characters of the left text, truncating from the front if needed.
32    return textLeftOfCursor.slice(Math.max(0, textLeftOfCursor.length - 10));
33}
34
35// Function to move the cursor 'k' positions to the right, returning at most 10 characters before the cursor.
36function cursorRight(k: number): string {
37    // Bound 'k' to the number of characters available to move right.
38    k = Math.min(k, textRightOfCursor.length);
39    while (k-- > 0) {
40        // Move the last character of the right text to the end of the left text.
41        textLeftOfCursor += textRightOfCursor.charAt(textRightOfCursor.length - 1);
42        // Remove the moved character from the right text.
43        textRightOfCursor = textRightOfCursor.slice(0, -1);
44    }
45    // Return at most 10 characters of the left text, truncating from the front if needed.
46    return textLeftOfCursor.slice(Math.max(0, textLeftOfCursor.length - 10));
47}
48
49// Example usage:
50// addText("hello");
51// let deletedChars: number = deleteText(3);
52// let leftSubstring: string = cursorLeft(2);
53// let rightSubstring: string = cursorRight(2);
54
Not Sure What to Study? Take the 2-min Quiz:

How does merge sort divide the problem into subproblems?

Time and Space Complexity

Time Complexity

  1. addText(text: str) -> None:

    • Appending each character from the input text to the self.left list has a time complexity of O(n) where n is the length of text.
  2. deleteText(k: int) -> int:

    • Deleting k elements from the end of self.left list has a time complexity of O(k) since each pop operation is O(1) and k such operations are performed.
  3. cursorLeft(k: int) -> str:

    • Moving cursor left k times involves popping elements from self.left and appending to self.right, each operation takes O(1) so overall operation is O(k). Then, joining the last 10 characters of self.left is O(1), as it deals with at most 10 characters regardless of the input size.
  4. cursorRight(k: int) -> str:

    • Similar to cursorLeft, moving the cursor right has a time complexity of O(k) for moving characters, and O(1) for joining up to 10 characters. So, overall complexity is O(k).

Space Complexity

  • The overall space complexity of the TextEditor class is O(m + n) where m is the total number of characters to the left of cursor and n is the total number of characters to the right of cursor. Since the input text is stored within these two lists, this accounts for the space taken up by the editor's content.

Learn more about how to find time and space complexity quickly using problem constraints.

Fast Track Your Learning with Our Quick Skills Quiz:

Which of the following array represent a max heap?


Recommended Readings


Got a question? Ask the Teaching Assistant anything you don't understand.

Still not clear? Ask in the Forum,  Discord or Submit the part you don't understand to our editors.


TA 👨‍🏫