Decode the Coding Interview in Go: Real-World Examples/

...

/

Feature #11: Directory Iterator

Feature #11: Directory Iterator

Implementing the "Directory Iterator" feature for our "Operating System" project.

We'll cover the following...

Description

In this feature, we will create a directory tree iterator. A directory can contain files or other directories. Similarly, subdirectories can contain both files and other directories. We will be given a directory structure for a specific directory in the file system. This directory will be available as a list. Each element of this list is either a file represented as a scalar element, or a directory represented as a nested list. We will have to iterate over all of the files one by one, using an iterator.

The task is to implement the NestedIterator class:

  • Constructor(nestedList []*NestedDirectories) *NestedIterator initializes the iterator with the nested list nestedList.
  • HasNext() bool returns the next file in the nested directories.
  • Next() string returns true if there are still some files in the nested list. If there are no files left in the nested list, it returns false.

Solution

We will use a stack to solve this feature. The stack will be used to store the directories and files on the iterator object. In the constructor, we will push all the files and the directories in the stack in reverse order.

The HasNext function checks if the top element of the stack is a file or directory. If so, then it returns true. Otherwise, if the top element is a list of files or directories, then it pops from the stack and pushes each element of the list in the stack in reverse order. This way, the lists at the top of the stack are converted into individual files or a directory whenever the HasNext function is called.

The Next function first calls the HasNext function to check if there is any file or directory in the stack. If the HasNext function returns true, then it pops from the stack and returns the topmost value.

Here is an example of how this function works:

Let’s look at the code for this solution:

main.go
Stack.go
NestedDirectory.go
package main
import (
  "fmt"
)
type NestedIterator struct {
  stack Stack
}
 
func Constructor(nestedList []*NestedDirectories) *NestedIterator {
    n := new(NestedIterator)
    for i := len(nestedList) - 1; i >= 0; i-- {
        n.stack.Push(nestedList[i])
    }
    return n
}
func (this *NestedIterator) HasNext() bool {
    for !this.stack.Empty() {
        top := this.stack.Top()
        if top.IsFile(){ return true }
        topList := top.GetList()
        this.stack.Pop()
        for i := len(topList) - 1; i >= 0; i-- {
            this.stack.Push(topList[i])
        }
    }
    return false
}
func (this *NestedIterator) Next() string {
    if this.HasNext() {
        top := this.stack.Top()
        this.stack.Pop()
        return top.GetFile().(string)
    }       
    return ""
}
func main() {
    // Driver Code
    nestedList := make([]*NestedDirectories, 0)
    l1 := InitNestedDirectories()
    nestedList = append(nestedList, NewNestedDirectories("F1"))
    l1.Add(NewNestedDirectories("F2"))
    l1.Add(NewNestedDirectories("D1"))
    nestedList = append(nestedList, l1)
    nestedList = append(nestedList, NewNestedDirectories("D2"))
    itr := Constructor(nestedList)
    fmt.Println("Original structure: [F1, [F2, D1], D2]")
    
    fmt.Println("Output:")
    for itr.HasNext() {
        fmt.Print("itr.Next(): ") 
        fmt.Println(itr.Next())
    }
}
Directory iterator

Complexity measures

Time complexity Space complexity
O(n+l)O(n + l)
...