APL-CORE: June 2021 Bug Fix Release of the APL 1.6 compliant core engine (1.6.1)

For more details on this release refer to CHANGELOG.md

To learn about APL see: https://developer.amazon.com/docs/alexa-presentation-language/understand-apl.html

Author: durjo-amz

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.6.1]
+
+### Changed
+
+- Improved pager fling behavior to provide a more consistent navigation
+- Fixed keyboard and focus handling when wrapping an EditText in a TouchWrapper
+- Updated PEGTL to version 2.8.3
+- Visibility property in visual context rounded to 2 decimal points
+- Perfomance improvements
+- Other bug fixes
+
 ## [1.6.0]
 
 This release adds support for version 1.6 of the APL specification.

THIRD-PARTY-NOTICES.txt

@@ -172,12 +172,12 @@ SOFTWARE.
 
 ------
 
-** pegtl 2.8; version 2.8.1 -- https://github.com/taocpp/PEGTL/
+** pegtl 2.8; version 2.8.3 -- https://github.com/taocpp/PEGTL/
 Copyright (c) 2007-2020 Dr. Colin Hirsch and Daniel Frey
 
 The MIT License (MIT)
 
-Copyright (c) 2007-2019 Dr. Colin Hirsch and Daniel Frey
+Copyright (c) 2007-2020 Dr. Colin Hirsch and Daniel Frey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

aplcore/include/apl/component/corecomponent.h

@@ -54,6 +54,16 @@ inline EventPropertyMap eventPropertyMerge(const EventPropertyMap& first, EventP
     return std::move(second);
 }
 
+enum PointerCaptureStatus {
+    /// The pointer has not been captured by any component
+    kPointerStatusNotCaptured,
+    /// The pointer has been captured by a component
+    kPointerStatusCaptured,
+    /// A component wants to capture the pointer, but is allowing other components to process the
+    // same pointer event first
+    kPointerStatusPendingCapture
+};
+
 /**
  * The native interface to a primitive APL Component.
  *
@@ -517,7 +527,7 @@ class CoreComponent : public Component,
     /**
      * @return The current calculated style.  This may be null.
      */
-    const StyleInstancePtr getStyle() const;
+    StyleInstancePtr getStyle() const;
 
     /**
      * Update the style of the component
@@ -636,12 +646,6 @@ class CoreComponent : public Component,
 
     void calculateDrawnBorder(bool useDirtyFlag);
 
-    /**
-     * @param position Point in global coordinates.
-     * @return Whether that point is within the bounds of this component.
-     */
-    bool containsGlobalPosition(const Point& position) const;
-
     /**
      * @param position Point in local coordinates.
      * @return Whether that point is within the bounds of this component.
@@ -772,9 +776,9 @@ class CoreComponent : public Component,
      * Defer pointer processing to component.
      * @param event pointer event.
      * @param timestamp event timestamp.
-     * @return true if pointer captured by a component processing, false otherwise.
+     * @return the status of the pointer following processing by this component
      */
-    virtual bool processPointerEvent(const PointerEvent& event, apl_time_t timestamp);
+    virtual PointerCaptureStatus processPointerEvent(const PointerEvent& event, apl_time_t timestamp);
 
     /**
      * @return The root configuration provided by the viewhost
@@ -906,6 +910,11 @@ class CoreComponent : public Component,
      */
     virtual void ensureDisplayedChildren();
 
+    /**
+     * @return True if layout change calculations should not be propagated to component's children. Usually the case
+     * when component itself is not taking part in the layout tree.
+     */
+    bool shouldNotPropagateLayoutChanges() const;
 
 private:
     friend streamer& operator<<(streamer&, const Component&);

aplcore/include/apl/component/edittextcomponent.h

@@ -46,7 +46,7 @@ class EditTextComponent : public ActionableComponent {
 protected:
     const ComponentPropDefSet& propDefSet() const override;
     const EventPropertyMap& eventPropertyMap() const override;
-    bool processPointerEvent(const PointerEvent& event, apl_time_t timestamp) override;
+    PointerCaptureStatus processPointerEvent(const PointerEvent& event, apl_time_t timestamp) override;
 
 private:
     CharacterRangesPtr mCharacterRangesPtr;

aplcore/include/apl/component/gridsequencecomponent.h

@@ -43,6 +43,7 @@ class GridSequenceComponent : public MultiChildScrollableComponent {
     void layoutChildIfRequired(const CoreComponentPtr& child,
                                size_t childIdx,
                                bool useDirtyFlag) override;
+    void ensureChildAttached(const CoreComponentPtr& child, int targetIdx) override;
     const EventPropertyMap & eventPropertyMap() const override;
 
     void handlePropertyChange(const ComponentPropDef& def, const Object& value) override;
@@ -51,12 +52,16 @@ class GridSequenceComponent : public MultiChildScrollableComponent {
 
     size_t getItemsPerCourse() const override { return mItemsPerCourse; }
 
+    size_t estimateChildrenToCover(float distance, size_t baseChild) override;
+
 private:
     std::pair<float, std::vector<float>> adjustChildDimensions(
         const Dimension& transAxisChildDimension,
         float transAxisSize,
         const ObjectArray& crossAxisArray,
         float crossAxisSize);
+
+    Size getChildSize(size_t index) const;
     void applyChildSize(const CoreComponentPtr& coreChild, size_t index) const;
     void calculateAbsoluteChildSizes(float gridWidth, float gridHeight);
     void calculateItemsPerCourse();

aplcore/include/apl/component/multichildscrollablecomponent.h

@@ -120,8 +120,9 @@ class MultiChildScrollableComponent : public ScrollableComponent {
     void removeChild(const CoreComponentPtr& child, size_t index, bool useDirtyFlag) override;
     bool getTags(rapidjson::Value& outMap, rapidjson::Document::AllocatorType& allocator) override;
     virtual void layoutChildIfRequired(const CoreComponentPtr& child, size_t childIdx, bool useDirtyFlag);
+    void relayoutInPlace(bool useDirtyFlag);
     float maxScroll() const override;
-    bool shouldAttachChildYogaNode(int index) const override;
+    bool shouldAttachChildYogaNode(int index) const override { return false; }
 
     const EventPropertyMap & eventPropertyMap() const override;
     void handlePropertyChange(const ComponentPropDef& def, const Object& value) override;
@@ -130,10 +131,15 @@ class MultiChildScrollableComponent : public ScrollableComponent {
 
     virtual size_t getItemsPerCourse() const { return 1; }
 
-    void ensureChildAttached(const CoreComponentPtr& child, int targetIdx);
+    virtual void ensureChildAttached(const CoreComponentPtr& child, int targetIdx);
 
     void attachYogaNode(const CoreComponentPtr& child) override;
 
+    /**
+     * Estimate number of children required to cover provided distance based on parameters of child provided.
+     */
+    virtual size_t estimateChildrenToCover(float distance, size_t baseChild) = 0;
+
 private:
     /**
      * Ensure that current state of visibility parameters properly calculated.
@@ -173,6 +179,7 @@ class MultiChildScrollableComponent : public ScrollableComponent {
 
     void attachYogaNodeIfRequired(const CoreComponentPtr& coreChild, int index) override;
     bool attachChild(const CoreComponentPtr& child, size_t index);
+    void runLayoutHeuristics(size_t anchorIdx, float childCache, float pageSize, bool useDirtyFlag);
 
 private:
     Range mIndexesSeen;

aplcore/include/apl/component/sequencecomponent.h

@@ -31,6 +31,7 @@ class SequenceComponent : public MultiChildScrollableComponent {
     const ComponentPropDefSet& propDefSet() const override;
     const ComponentPropDefSet* layoutPropDefSet() const override;
     bool childrenUseSpacingProperty() const override { return true; }
+    size_t estimateChildrenToCover(float distance, size_t baseChild) override;
 
 };
 

aplcore/include/apl/component/touchablecomponent.h

@@ -54,7 +54,7 @@ class TouchableComponent : public ActionableComponent {
     // TODO: override to be removed once we support handing intrinsic/reserved keys
     void update(UpdateType type, float value) override;
     void setGestureHandlers();
-    bool processPointerEvent(const PointerEvent& event, apl_time_t timestamp) override;
+    PointerCaptureStatus processPointerEvent(const PointerEvent& event, apl_time_t timestamp) override;
     void invokeStandardAccessibilityAction(const std::string& name) override;
 
 private:

aplcore/include/apl/engine/builder.h

@@ -79,17 +79,17 @@ class Builder {
 
     CoreComponentPtr expandSingleComponentFromArray(const ContextPtr& context,
                                                     const std::vector<Object>& items,
-                                                    Properties& properties,
+                                                    Properties&& properties,
                                                     const CoreComponentPtr& parent,
                                                     const Path& path);
 
     CoreComponentPtr expandSingleComponent(const ContextPtr& context,
                                            const Object& item,
-                                           Properties& properties,
+                                           Properties&& properties,
                                            const CoreComponentPtr& parent,
                                            const Path& path);
 
-    void attachBindings(const ContextPtr& context, const Object& item);
+    static void attachBindings(const ContextPtr& context, const Object& item);
 private:
     CoreComponentPtr mOld;
 };

aplcore/include/apl/focus/focusfinder.h

@@ -43,12 +43,17 @@ class FocusFinder {
 
     /**
      * Find next focusable component.
+     * @param focused currently focused component or nullptr if none.
      * @param focusedRect currently focused rectangle.
      * @param direction direction of search.
      * @param root root of search hierarchy.
      * @return Found component, nullptr otherwise.
      */
-    CoreComponentPtr findNext(const Rect& focusedRect, FocusDirection direction, const CoreComponentPtr& root);
+    CoreComponentPtr findNext(
+            const CoreComponentPtr& focused,
+            const Rect& focusedRect,
+            FocusDirection direction,
+            const CoreComponentPtr& root);
 
     /**
      * Get all focusable components in provided root.

aplcore/include/apl/focus/focusmanager.h

@@ -103,11 +103,12 @@ class FocusManager {
     /**
      * Find next component to be focused based on provided parameters.
      * @param direction direction of search.
-     * @param origin currently focused rectangle.
+     * @param origin Component focus originates from if any, nullptr otherwise.
+     * @param originRect currently focused rectangle.
      * @param root root of search hierarchy.
      * @return Found component, nullptr otherwise.
      */
-    CoreComponentPtr find(FocusDirection direction, const Rect& origin, const CoreComponentPtr& root);
+    CoreComponentPtr find(FocusDirection direction, const CoreComponentPtr& origin, const Rect& originRect, const CoreComponentPtr& root);
 
     /**
      * Get focusable areas available from APL Core.

aplcore/include/apl/utils/pagemovehandler.h

@@ -96,7 +96,9 @@ class PageMoveHandler {
 
 private:
     static ContextPtr createPageMoveContext(
-            float amount, SwipeDirection direction,
+            float amount,
+            SwipeDirection direction,
+            const CoreComponentPtr& self,
             const CoreComponentPtr& currentChild,
             const CoreComponentPtr& nextChild);
     static ITPtr getPageTransformation(

aplcore/src/command/clearfocuscommand.cpp

@@ -30,7 +30,7 @@ ClearFocusCommand::execute(const TimersPtr& timers, bool fastMode) {
         return nullptr;
 
     auto& fm = mContext->focusManager();
-    fm.clearFocus(true);
+    fm.clearFocus(true, kFocusDirectionNone, true);
     return nullptr;
 }