kubevela/references/cli/top/model/stack.go

/*
Copyright 2022 The KubeVela Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package model

import "sync"

const (
	// stackPush is the "push" notify type
	stackPush = iota
	// StackPop is the "pop" notify type
	StackPop
)

// ResourceListener listen notify from the main view of app and render itself again
type ResourceListener interface {
	// StackPop pop old component and render component
	StackPop(Component, Component)
	// StackPush push a new component
	StackPush(Component)
}

// Stack is a stack to store components and notify listeners of main view of app
type Stack struct {
	components []Component
	listeners  []ResourceListener
	mx         sync.RWMutex
}

// NewStack return a new stack instance
func NewStack() *Stack {
	return &Stack{
		components: make([]Component, 0),
		listeners:  make([]ResourceListener, 0),
	}
}

// AddListener add a new resource listener
func (s *Stack) AddListener(listener ResourceListener) {
	s.listeners = append(s.listeners, listener)
}

// RemoveListener remove the aim resource listener
func (s *Stack) RemoveListener(listener ResourceListener) {
	aimIndex := -1
	for index, item := range s.listeners {
		if item == listener {
			aimIndex = index
		}
	}
	if aimIndex == -1 {
		return
	}
	s.listeners = append(s.listeners[:aimIndex], s.listeners[aimIndex+1:]...)
}

// TopComponent return top component of stack
func (s *Stack) TopComponent() Component {
	if s.Empty() {
		return nil
	}
	return s.components[len(s.components)-1]
}

// IsLastComponent check whether stack only have one component now
func (s *Stack) IsLastComponent() bool {
	return len(s.components) == 1
}

// PopComponent pop a component from stack
func (s *Stack) PopComponent() {
	if s.Empty() {
		return
	}

	s.mx.Lock()
	removeComponent := s.components[len(s.components)-1]
	s.components = s.components[:len(s.components)-1]
	s.mx.Unlock()

	s.notifyListener(StackPop, removeComponent)
}

// PushComponent add a new component to stack
func (s *Stack) PushComponent(component Component) {
	if top := s.TopComponent(); top != nil {
		top.Stop()
	}

	s.mx.Lock()
	s.components = append(s.components, component)
	s.mx.Unlock()

	s.notifyListener(stackPush, component)
}

// Empty return whether stack is empty
func (s *Stack) Empty() bool {
	return len(s.components) == 0
}

func (s *Stack) notifyListener(action int, component Component) {
	for _, listener := range s.listeners {
		switch action {
		case stackPush:
			listener.StackPush(component)
		case StackPop:
			listener.StackPop(component, s.TopComponent())
		}
	}
}