Managing Document History with Stacks in Kotlin

Welcome! Today, we will delve into managing a document's editing history using stacks. Imagine building a text editor; you would need to handle actions like adding text, undoing it, and redoing those changes. We will see how these features can be efficiently implemented using stacks. By the end of this lesson, you will possess an in-depth understanding of applying stacks in practical scenarios.

Before starting the coding portion, let's dissect the methods we will implement. These methods will manage a document's edit history, allowing us to apply changes, undo them, and redo them effectively.

• applyChange(change: String): This method applies a change to the document. The change, represented as a string, is stored in a way that allows us to remember the order of applied changes. Any previously undone changes are discarded.

• undo(): String?: This method undoes the most recent change and allows us to store it for a possible redo. It returns the change that was undone. If there are no changes available to undo, it returns null.

• redo(): String?: This method redoes the most recent undone change, making it active again. It returns the change that was redone. If there are no changes available to redo, it returns null.

• getChanges(): List<String>: This method returns a list of all applied changes in the order they were applied.

To implement these methods efficiently, we'll use two stacks. We use stacks to keep track of applied changes and undone changes because of their LIFO (Last In, First Out) property. The most recent change is always at the top, making it easy to undo and redo.

Let's break down each method's implementation and study how they interact with the stacks.

Let's implement the solution step-by-step. Firstly, we define our class and set up the initial state.

class DocumentHistory {
    // Stacks to track current changes and undone changes that can be redone
    private val changesStack = mutableListOf<String>()
    private val redoStack = mutableListOf<String>()
}

Here, DocumentHistory is the class, and we initialize changesStack as a MutableList to act as our stack of applied changes, and redoStack as another MutableList for undone changes.