status-bar-view-model.ts

// *****************************************************************************
// Copyright (C) 2022 Ericsson and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************

import { injectable } from 'inversify';
import { ArrayUtils, Emitter, Event } from '../../common';
import { StatusBarAlignment, StatusBarEntry, StatusBarViewEntry, StatusBarViewModelEntry } from './status-bar-types';

interface EntryLocation {
    container: StatusBarViewModelEntry[];
    index: number;
    entry: StatusBarViewModelEntry;
}

@injectable()
export class StatusBarViewModel {
    protected leftTree = new Array<StatusBarViewModelEntry>();
    protected rightTree = new Array<StatusBarViewModelEntry>();
    protected containerPointers = new Map<string, StatusBarViewModelEntry[]>();
    protected onDidChangeEmitter = new Emitter<void>();
    get onDidChange(): Event<void> {
        return this.onDidChangeEmitter.event;
    }

    *getLeft(): IterableIterator<StatusBarViewEntry> {
        yield* this.getEntries(this.leftTree);
    }

    *getRight(): IterableIterator<StatusBarViewEntry> {
        yield* this.getEntries(this.rightTree);
    }

    *getEntries(list: StatusBarViewModelEntry[]): IterableIterator<StatusBarViewEntry> {
        for (const item of list) {
            yield* this.getChildren(item.leftChildren, StatusBarAlignment.LEFT);
            yield { entry: item.head, id: item.id };
            yield* this.getChildren(item.rightChildren, StatusBarAlignment.RIGHT);
        }
    }

    *getChildren(list: StatusBarViewModelEntry[], alignment: StatusBarAlignment, compact?: boolean): IterableIterator<StatusBarViewEntry> {
        for (const item of list) {
            if (item.leftChildren.length || item.rightChildren.length) {
                console.warn(`Found embedded entries with affinity to ${item.id}. They will inherit alignment and compactness of parent.`);
            }
            yield* this.getChildren(item.leftChildren, alignment, item.head.affinity?.compact);
            yield { entry: item.head, id: item.id, alignment, compact: compact || item.head.affinity?.compact };
            yield* this.getChildren(item.rightChildren, alignment, item.head.affinity?.compact);
        }
    }

    set(id: string, entry: StatusBarEntry): void {
        const existing = this.findElement(id);
        if (existing) {
            const oldEntry = existing.entry.head;
            existing.entry.head = entry;
            if (!this.shareSameContainer(entry, oldEntry)) {
                this.relocate(existing);
            } else if (!this.shareSamePriority(entry, oldEntry)) {
                this.sort(existing.container);
            }
        } else {
            const container = this.getContainerFor(entry);
            const viewModelEntry = { id, head: entry, leftChildren: [], rightChildren: [] };
            container.push(viewModelEntry);
            this.containerPointers.set(id, container);
            const pendingDependents = this.getDependentsOf(id);
            pendingDependents.forEach(newChild => this.relocate(newChild, true));
            this.sortDependents(viewModelEntry.leftChildren);
            this.sortDependents(viewModelEntry.rightChildren);
            this.sort(container);
        }
        this.onDidChangeEmitter.fire();
    }

    protected relocate(locationData: EntryLocation, dontSort?: boolean): void {
        const newContainer = this.getContainerFor(locationData.entry.head);
        locationData.container.splice(locationData.index, 1);
        newContainer.push(locationData.entry);
        this.containerPointers.set(locationData.entry.id, newContainer);
        if (!dontSort) {
            this.sort(newContainer);
        }
    }

    protected getContainerFor(entry: StatusBarEntry): StatusBarViewModelEntry[] {
        const affinityParent = entry.affinity && this.findElement(entry.affinity.id);
        if (affinityParent) {
            return entry.affinity!.alignment === StatusBarAlignment.LEFT ? affinityParent.entry.leftChildren : affinityParent.entry.rightChildren;
        }
        return entry.alignment === StatusBarAlignment.LEFT ? this.leftTree : this.rightTree;
    }

    protected getDependentsOf(id: string): EntryLocation[] {
        const dependents = [];
        for (let index = 0; index < this.rightTree.length || index < this.leftTree.length; index++) {
            if (this.rightTree[index]?.head.affinity?.id === id) {
                dependents.push({ index, container: this.rightTree, entry: this.rightTree[index] });
            }
            if (this.leftTree[index]?.head.affinity?.id === id) {
                dependents.push({ index, container: this.leftTree, entry: this.leftTree[index] });
            }
        }
        return dependents;
    }

    remove(id: string): boolean {
        const location = this.findElement(id);
        if (location) {
            this.containerPointers.delete(id);
            location.container.splice(location.index, 1);
            const originalLeftLength = this.leftTree.length;
            const originalRightLength = this.rightTree.length;
            this.inline(location.entry.leftChildren, location.entry.rightChildren);
            if (originalLeftLength !== this.leftTree.length) {
                this.sortTop(this.leftTree);
            }
            if (originalRightLength !== this.rightTree.length) {
                this.sortTop(this.rightTree);
            }
            this.onDidChangeEmitter.fire();
            return true;
        }
        return false;
    }

    protected shareSamePositionParameters(left: StatusBarEntry, right: StatusBarEntry): boolean {
        if ((left.priority ?? 0) !== (right.priority ?? 0)) { return false; }
        if (this.affinityMatters(left, right)) {
            return left.affinity?.id === right.affinity?.id && left.affinity?.alignment === right.affinity?.alignment && left.affinity?.compact === right.affinity?.compact;
        }
        return left.alignment === right.alignment;
    }

    protected shareSameContainer(left: StatusBarEntry, right: StatusBarEntry): boolean {
        if (this.affinityMatters(left, right)) {
            return left.affinity?.id === right.affinity?.id && left.affinity?.alignment === right.affinity?.alignment;
        }
        return left.alignment === right.alignment;
    }

    protected shareSamePriority(left: StatusBarEntry, right: StatusBarEntry): boolean {
        return (left.priority ?? 0) === (right.priority ?? 0) && (!this.affinityMatters(left, right) || left.affinity?.compact === right.affinity?.compact);
    }

    protected affinityMatters(left: StatusBarEntry, right: StatusBarEntry): boolean {
        return (left.affinity && this.containerPointers.has(left.affinity.id)) || Boolean(right.affinity && this.containerPointers.has(right.affinity.id));
    }

    protected findElement(id?: string): EntryLocation | undefined {
        const container = id !== undefined && this.containerPointers.get(id);
        if (container) {
            const index = container.findIndex(candidate => candidate.id === id);
            if (index !== -1) {
                return { index, entry: container[index], container };
            }
        }
    }

    protected sort(container: StatusBarViewModelEntry[]): void {
        if (container === this.leftTree || container === this.rightTree) {
            this.sortTop(container);
        } else {
            this.sortDependents(container);
        }
    }

    protected sortTop(container: StatusBarViewModelEntry[]): void {
        container.sort((left, right) => this.comparePriority(left, right));
    }

    protected comparePriority(left: StatusBarViewModelEntry, right: StatusBarViewModelEntry): number {
        return (right.head.priority ?? 0) - (left.head.priority ?? 0);
    }

    protected sortDependents(container: StatusBarViewModelEntry[]): void {
        container.sort((left, right) => {
            if (left.head.affinity?.compact && !right.head.affinity?.compact) {
                return ArrayUtils.Sort.LeftBeforeRight;
            } else if (right.head.affinity?.compact) {
                return ArrayUtils.Sort.RightBeforeLeft;
            }
            return this.comparePriority(left, right);
        });
    }

    protected inline(left: StatusBarViewModelEntry[], right: StatusBarViewModelEntry[]): void {
        for (const entry of left) { this.doAddTop(entry); }
        for (const entry of right) { this.doAddTop(entry); }
    }

    protected doAddTop(entry: StatusBarViewModelEntry): void {
        const container = entry.head.alignment === StatusBarAlignment.LEFT ? this.leftTree : this.rightTree;
        this.containerPointers.set(entry.id, container);
        container.push(entry);
    }
}