@react-native-ohos/flash-list 1.8.3-rc.1

package/harmony/flash_list/src/main/cpp/Props.cpp

@@ -0,0 +1,52 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include "Props.h"
+#include <react/renderer/core/PropsParserContext.h>
+#include <react/renderer/core/propsConversions.h>
+
+namespace facebook {
+namespace react {
+
+AutoLayoutViewProps::AutoLayoutViewProps(const PropsParserContext &context, const AutoLayoutViewProps &sourceProps,
+                                         const RawProps &rawProps)
+    : ViewProps(context, sourceProps, rawProps),
+
+      horizontal(convertRawProp(context, rawProps, "horizontal", sourceProps.horizontal, {false})),
+      scrollOffset(convertRawProp(context, rawProps, "scrollOffset", sourceProps.scrollOffset, {0.0})),
+      windowSize(convertRawProp(context, rawProps, "windowSize", sourceProps.windowSize, {0.0})),
+      renderAheadOffset(convertRawProp(context, rawProps, "renderAheadOffset", sourceProps.renderAheadOffset, {0.0})),
+      enableInstrumentation(
+          convertRawProp(context, rawProps, "enableInstrumentation", sourceProps.enableInstrumentation, {false})),
+      disableAutoLayout(
+          convertRawProp(context, rawProps, "disableAutoLayout", sourceProps.disableAutoLayout, {false})) {}
+
+CellContainerProps::CellContainerProps(const PropsParserContext &context, const CellContainerProps &sourceProps,
+                                       const RawProps &rawProps)
+    : ViewProps(context, sourceProps, rawProps),
+
+      index(convertRawProp(context, rawProps, "index", sourceProps.index, {0})) {}
+
+} // namespace react
+} // namespace facebook

package/harmony/flash_list/src/main/cpp/Props.h

@@ -0,0 +1,64 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef FLASH_SRC_MAIN_CPP_PROPS_H
+#define FLASH_SRC_MAIN_CPP_PROPS_H
+
+#include <jsi/jsi.h>
+#include <react/renderer/components/view/ViewProps.h>
+#include <react/renderer/core/PropsParserContext.h>
+
+namespace facebook {
+namespace react {
+
+class JSI_EXPORT AutoLayoutViewProps final : public ViewProps {
+public:
+    AutoLayoutViewProps() = default;
+    AutoLayoutViewProps(const PropsParserContext &context, const AutoLayoutViewProps &sourceProps,
+                        const RawProps &rawProps);
+
+#pragma mark - Props
+
+    bool horizontal{false};
+    facebook::react::Float scrollOffset{0.0};
+    facebook::react::Float windowSize{0.0};
+    facebook::react::Float renderAheadOffset{0.0};
+    bool enableInstrumentation{false};
+    bool disableAutoLayout{false};
+};
+
+class JSI_EXPORT CellContainerProps final : public ViewProps {
+public:
+    CellContainerProps() = default;
+    CellContainerProps(const PropsParserContext &context, const CellContainerProps &sourceProps,
+                       const RawProps &rawProps);
+
+#pragma mark - Props
+
+    int index{0};
+};
+
+} // namespace react
+} // namespace facebook
+#endif

package/harmony/flash_list/src/main/cpp/ShadowNodes.cpp

@@ -0,0 +1,34 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include "ShadowNodes.h"
+
+namespace facebook {
+namespace react {
+
+extern const char AutoLayoutViewComponentName[] = "AutoLayoutView";
+extern const char CellContainerComponentName[] = "CellContainer";
+
+} // namespace react
+} // namespace facebook

package/harmony/flash_list/src/main/cpp/ShadowNodes.h

@@ -0,0 +1,48 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef FLASH_SRC_MAIN_CPP_SHADOWNODES_H
+#define FLASH_SRC_MAIN_CPP_SHADOWNODES_H
+
+#include <react/renderer/components/view/ConcreteViewShadowNode.h>
+#include <react/renderer/components/view/ViewShadowNode.h>
+#include <jsi/jsi.h>
+#include "EventEmitters.h"
+#include "Props.h"
+
+namespace facebook {
+namespace react {
+
+JSI_EXPORT extern const char AutoLayoutViewComponentName[];
+JSI_EXPORT extern const char CellContainerComponentName[];
+
+using AutoLayoutViewShadowNode =
+    ConcreteViewShadowNode<AutoLayoutViewComponentName, AutoLayoutViewProps, AutoLayoutViewEventEmitter>;
+
+using CellContainerShadowNode =
+    ConcreteViewShadowNode<CellContainerComponentName, CellContainerProps, ViewEventEmitter>;
+
+} // namespace react
+} // namespace facebook
+#endif

package/harmony/flash_list/src/main/ets/Logger.ets

@@ -0,0 +1,64 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import hilog from '@ohos.hilog';
+
+class Logger {
+  private domain : number;
+  private prefix : string;
+  private format : string = '%{public}s, %{public}s';
+  private isDebug : boolean;
+
+  /**
+   * constructor.
+   *
+   * @param Prefix Identifies the log tag.
+   * @param domain Domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFFF.
+   */
+  constructor(prefix: string = 'MyApp', domain: number = 0xFF00, isDebug = false) {
+    this.prefix = prefix;
+    this.domain = domain;
+    this.isDebug = isDebug;
+  }
+
+  debug(...args: string[]): void {
+    if (this.isDebug) {
+      hilog.debug(this.domain, this.prefix, this.format, args);
+    }
+  }
+
+  info(...args: string[]): void {
+    hilog.info(this.domain, this.prefix, this.format, args);
+  }
+
+  warn(...args: string[]) : void {
+    hilog.warn(this.domain, this.prefix, this.format, args);
+  }
+
+  error(...args: string[]) : void {
+    hilog.error(this.domain, this.prefix, this.format, args);
+  }
+}
+
+export default new Logger('FlashList', 0xFF00, false)

package/harmony/flash_list/src/main/ets/RNAutoLayoutShadow.ets

@@ -0,0 +1,154 @@
+/**
+ * MIT License
+ *
+ * Copyright (C) 2024 Huawei Device Co., Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { CellContainerDescriptor } from "./RNCellContainer";
+import { RNOHContext } from '@rnoh/react-native-openharmony';
+import Logger from './Logger';
+
+export class AutoLayoutShadow {
+  horizontal: boolean = false;
+  scrollOffset: number = 0;
+  offsetFromStart: number = 0;
+  windowSize: number = 0;
+  renderOffset: number = 0;
+
+  blankOffsetAtStart: number = 0; // Tracks blank area from the top
+  blankOffsetAtEnd: number = 0; // Tracks blank area from the bottom
+
+  lastMaxBoundOverall: number = 0; // Tracks where the last pixel is drawn in the overall
+
+  private lastMaxBound: number = 0; // Tracks where the last pixel is drawn in the visible window
+  private lastMinBound: number = 0; // Tracks where first pixel is drawn in the visible window
+
+  /** Checks for overlaps or gaps between adjacent items and then applies a correction (Only Grid layouts with varying spans)
+   * Performance: RecyclerListView renders very small number of views and this is not going to trigger multiple layouts on Android side. Not expecting any major perf issue. */
+  clearGapsAndOverlaps(sortedItems: number[], ctx: RNOHContext): void {
+    let maxBound = 0;
+    let minBound = Number.MAX_SAFE_INTEGER;
+    let maxBoundNeighbour = 0;
+    this.lastMaxBoundOverall = 0;
+    for (let i = 0; i < sortedItems.length - 1; i++) {
+      const cell =  ctx.descriptorRegistry.getDescriptor<CellContainerDescriptor>(sortedItems[i]);
+      Logger.debug(`[RNOH]: in AutoLayoutShadow cell: ${JSON.stringify(cell)}`)
+      const neighbour = ctx.descriptorRegistry.getDescriptor<CellContainerDescriptor>(sortedItems[i+1]);
+      Logger.debug(`[RNOH]: in AutoLayoutShadow neighbour: ${JSON.stringify(neighbour)}`)
+      let isNeighbourConsecutive = neighbour.rawProps.index === cell.rawProps.index ?? -1 + 1;
+      if (this.isWithinBounds(cell)) {
+        if (!this.horizontal) {
+          maxBound = Math.max(maxBound, cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height);
+          minBound = Math.min(minBound, cell.layoutMetrics.frame.origin.y);
+          maxBoundNeighbour = maxBound;
+          if (isNeighbourConsecutive) {
+            if (cell.layoutMetrics.frame.origin.x < neighbour.layoutMetrics.frame.origin.x) {
+              if (cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width !==
+              neighbour.layoutMetrics.frame.origin.x) {
+                neighbour.layoutMetrics.frame.origin.x = cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width;
+              }
+              if (cell.layoutMetrics.frame.origin.y !== neighbour.layoutMetrics.frame.origin.y) {
+                neighbour.layoutMetrics.frame.origin.y = cell.layoutMetrics.frame.origin.y;
+              }
+            } else {
+              neighbour.layoutMetrics.frame.origin.y = maxBound;
+            }
+          }
+          if (this.isWithinBounds(neighbour)) {
+            maxBoundNeighbour = Math.max(maxBound, neighbour.layoutMetrics.frame.origin.y + neighbour.layoutMetrics.frame.size.height);
+          }
+        } else {
+          maxBound = Math.max(maxBound, cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width);
+          minBound = Math.min(minBound, cell.layoutMetrics.frame.origin.x);
+          maxBoundNeighbour = maxBound;
+          if (cell.layoutMetrics.frame.origin.y < neighbour.layoutMetrics.frame.origin.y) {
+            if (cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height !== neighbour.layoutMetrics.frame.origin.y) {
+              neighbour.layoutMetrics.frame.origin.y = cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height;
+            }
+            if (cell.layoutMetrics.frame.origin.x !== neighbour.layoutMetrics.frame.origin.x) {
+              neighbour.layoutMetrics.frame.origin.x = cell.layoutMetrics.frame.origin.x;
+            }
+          } else {
+            neighbour.layoutMetrics.frame.origin.x = maxBound;
+          }
+          if (this.isWithinBounds(neighbour)) {
+            maxBoundNeighbour = Math.max(maxBound, neighbour.layoutMetrics.frame.origin.x + neighbour.layoutMetrics.frame.size.width);
+          }
+        }
+      }
+      this.lastMaxBoundOverall = Math.max(
+        this.lastMaxBoundOverall,
+        this.horizontal ? cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width :
+          cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height
+      );
+      this.lastMaxBoundOverall = Math.max(
+        this.lastMaxBoundOverall,
+        this.horizontal ? neighbour.layoutMetrics.frame.origin.x + neighbour.layoutMetrics.frame.size.width :
+          neighbour.layoutMetrics.frame.origin.y + neighbour.layoutMetrics.frame.size.height
+      );
+    }
+    this.lastMaxBound = maxBoundNeighbour;
+    this.lastMinBound = minBound;
+  }
+
+  /** Offset provided by react can be one frame behind the real one, it's important that this method is called with offset taken directly from
+   * scrollview object */
+  computeBlankFromGivenOffset(
+    actualScrollOffset: number,
+    distanceFromWindowStart: number,
+    distanceFromWindowEnd: number
+  ): number {
+    const actualOffset = actualScrollOffset - this.offsetFromStart;
+    this.blankOffsetAtStart = this.lastMinBound - actualOffset - distanceFromWindowStart;
+    this.blankOffsetAtEnd =
+      actualOffset +
+      this.windowSize -
+      this.renderOffset -
+      this.lastMaxBound -
+        distanceFromWindowEnd;
+    return Math.max(this.blankOffsetAtStart, this.blankOffsetAtEnd);
+  }
+
+  /** It's important to avoid correcting views outside the render window. An item that isn't being recycled might still remain in the view tree. If views outside get considered then gaps between
+   * unused items will cause algorithm to fail.*/
+  private isWithinBounds(cell: CellContainerDescriptor): boolean {
+    const scrollOffset = this.scrollOffset - this.offsetFromStart;
+    if (!this.horizontal) {
+      return (
+        (cell.layoutMetrics.frame.origin.y >= (scrollOffset - this.renderOffset) ||
+          (cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height) >=
+            (scrollOffset - this.renderOffset) ) &&
+          (cell.layoutMetrics.frame.origin.y <= (scrollOffset + this.windowSize) ||
+            (cell.layoutMetrics.frame.origin.y + cell.layoutMetrics.frame.size.height) <=
+              (scrollOffset + this.windowSize) )
+      );
+    } else {
+      return (
+        (cell.layoutMetrics.frame.origin.x >= (scrollOffset - this.renderOffset) ||
+          (cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width) >=
+            (scrollOffset - this.renderOffset)) &&
+          (cell.layoutMetrics.frame.origin.x <= (scrollOffset + this.windowSize) ||
+            (cell.layoutMetrics.frame.origin.x + cell.layoutMetrics.frame.size.width) <=
+              (scrollOffset + this.windowSize))
+      );
+    }
+  }
+}