• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16
17/*  UINodeRegisterProxy singeleton class
18
19Acts on behave on ElementRegister to hold elmtIds of deleted UINodes
20until these get unregistered from a ViewPU.
21
22Two flows inside the framework that involve UINodeRegisterProxy:
23
24Flow A:
251. UINode Destructor calls ElementRegister.RemoveItem(UINode's elmtId) - processing stops:
26
272. Some time later on next re-render of a ViewPU:
283. ViewPU.purgeDeletedElmtIds calls C+++ UINodeRegisterProxy.obtainElementIds(),
294. UINodeRegisterProxy.obtainElementIds() calls C++  ElementRegister::MoveRemovedItems to move elmtIds of deleted UINodes UINodeRegisterProxy
30   (those added by RemoveItems(elmtId) in step 1).
315. UINodeRegisterProxy.unregisterElmtIdsFromViewPUs: unregister the removedElementIds from the all the viewpus:
32  1) purge the update function in viewpu
33  2) purge the dependent element if from statevariable
34
35Flow B:
361. CustomNode destructor calls deleteFunction calls ViewPU.aboutToBeDeleted
37   note that CustomNode destructor may get called before child UINodes' destructor.
38  1) unregister its own element ids
39  2) call UINodeRegisterProxy.obtainElementIds() to get the removed elementIds from cpp and unregister from all the viewpus.
40     it may make the first viewpu aboutToBeDeleted execution time longer than before, but for rest viewpu may be faster.
41     It's function equals with purgeDeletedElmtIdsRecursively, so it is not necessary to execute purgeDeletedElmtIds for all its child recursively.
42
432. some time later or when idle: PipelineContext::OnIdle will CallJSCleanUpIdleTaskFunc to do the clean up for the removed elements which have not unregisted
44   from the stateMgmt side.
45*/
46
47type RemovedElementInfo = { elmtId : number, tag : string };
48// defined a globle function to clean up the removeItems when idle
49function uiNodeCleanUpIdleTask(): void {
50    stateMgmtConsole.debug(`UINodeRegisterProxy. static uiNodeCleanUpIdleTask:`);
51    UINodeRegisterProxy.obtainDeletedElmtIds();
52    UINodeRegisterProxy.unregisterElmtIdsFromViewPUs();
53}
54
55class UINodeRegisterProxy {
56    public static obtainDeletedElmtIds(): void {
57        stateMgmtConsole.debug(`UINodeRegisterProxy. static obtainDeletedElmtIds:`);
58        if ((!UINodeRegisterProxy.instance_.obtainDeletedElmtIds) || typeof UINodeRegisterProxy.instance_.obtainDeletedElmtIds != "function") {
59            stateMgmtConsole.error(`UINodeRegisterProxy obtainDeletedElmtIds is not a function: ${UINodeRegisterProxy.instance_.obtainDeletedElmtIds}.` );
60        } else {
61            UINodeRegisterProxy.instance_.obtainDeletedElmtIds();
62        }
63    }
64
65    public static unregisterElmtIdsFromViewPUs(): void {
66        stateMgmtConsole.debug('UINodeRegisterProxy.unregisterElmtIdsFromViewPUs elmtIds');
67        UINodeRegisterProxy.instance_.unregisterElmtIdsFromViewPUs();
68    }
69
70    // unregisters all the received removedElements in func parameter
71    public static unregisterRemovedElmtsFromViewPUs(removedElements: Array<number>): void {
72
73        stateMgmtConsole.debug(`UINodeRegisterProxy.unregisterRemovedElmtsFromViewPUs elmtIds ${removedElements}`);
74        UINodeRegisterProxy.instance_.populateRemoveElementInfo(removedElements);
75        UINodeRegisterProxy.instance_.unregisterElmtIdsFromViewPUs();
76    }
77
78    private populateRemoveElementInfo(removedElements: Array<number>) {
79        for (const elmtId of removedElements) {
80            const removedElementInfo: RemovedElementInfo = { elmtId, tag: "" };
81            this.removeElementsInfo_.push(removedElementInfo);
82        }
83    }
84
85    /* just get the remove items from the native side
86    */
87    private obtainDeletedElmtIds(): void {
88        stateMgmtConsole.debug('UINodeRegisterProxy.obtainDeletedElmtIds: ');
89        let removedElementsInfo = new Array<RemovedElementInfo>();
90        ViewStackProcessor.moveDeletedElmtIds(removedElementsInfo);
91        stateMgmtConsole.debug(`   ... ${removedElementsInfo.length} elmtIds newly obtained from ElementRegister: ${JSON.stringify(removedElementsInfo)} .`);
92        this.removeElementsInfo_ = removedElementsInfo;
93    }
94
95    public unregisterElmtIdsFromViewPUs(): void {
96        stateMgmtConsole.debug(`${this.removeElementsInfo_.length} elmtIds newly obtained from ElementRegister: ${JSON.stringify(this.removeElementsInfo_)} .`);
97
98        if (this.removeElementsInfo_.length == 0) {
99            stateMgmtConsole.debug(`${this.removeElementsInfo_.length} elmtIds needs to purgeDelete. } .`);
100            return;
101        }
102        let owningView : ViewPU | undefined;
103        this.removeElementsInfo_.forEach((rmElmtInfo  : RemovedElementInfo) => {
104            const owningViewPUWeak : WeakRef<ViewPU> = UINodeRegisterProxy.ElementIdToOwningViewPU_.get(rmElmtInfo.elmtId );
105            if (owningViewPUWeak != undefined) {
106                owningView = owningViewPUWeak.deref();
107                if (owningView) {
108                    owningView.purgeDeleteElmtId(rmElmtInfo.elmtId);
109                } else {
110                    stateMgmtConsole.debug(`elmtIds ${rmElmtInfo.elmtId} tag: ${rmElmtInfo.tag} has not been removed because of failure of updating the weakptr of viewpu. Internal error!.`);
111                }
112            } else {
113                stateMgmtConsole.debug(`elmtIds ${rmElmtInfo.elmtId} tag: ${rmElmtInfo.tag} cannot find its owning viewpu, maybe this viewpu has already been abouttobedeleted. Internal error!`)
114            }
115        })
116
117        this.removeElementsInfo_.length = 0;
118    }
119
120    public static instance_: UINodeRegisterProxy = new UINodeRegisterProxy();
121    public removeElementsInfo_: Array<RemovedElementInfo> = new Array<RemovedElementInfo>();
122    public static ElementIdToOwningViewPU_: Map<number, WeakRef<ViewPU>> = new Map<number, WeakRef<ViewPU>>();
123}
124