APL-CORE: July 2020 Release of APL 1.4 compliant core engine (1.4.0)

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: bddufour

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.4.0]
+
+This release adds support for version 1.4 of the APL specification.
+
+### Added
+
+- New components: EditText and GridSequence
+- New AVG features (e.g. text support) and improvements
+- Tick handlers
+- onDown, onMove, and onUp event handlers to touchable components (e.g VectorGraphic and TouchWrapper)
+- Gesture support
+- Named sequencers for commands in order to control which commands can execute in parallel
+- Transcendental math functions
+- Misc updates to component properties
+
+### Changed
+
+- Updated reported APL version to 1.4
+- Bug fixes
+- Build improvements
+
 ## [1.3.3]
 
 This release is a bug fix release of apl-core-library

CMakeLists.txt

@@ -12,7 +12,11 @@
 # permissions and limitations under the License.
 
 cmake_minimum_required(VERSION 3.5)
-project(APLCoreEngine)
+
+project(APLCoreEngine
+        VERSION 1.0.0
+        LANGUAGES CXX)
+
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 

NOTICE.txt

@@ -1,5 +1,5 @@
 APL Core Library
-Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 The APL Core Library is licensed under the Apache
 License, Version 2.0 (the "License").
@@ -29,8 +29,6 @@ Copyright (c) 2007-2019 Dr. Colin Hirsch and Daniel Frey.
 
 - Yoga - Copyright (c) Facebook, Inc. and its affiliates.
 
-- Templatized C++ Command Line Parser Library - Copyright (c), Michael E. Smoot.
-
 - C++ test framework from Google Test - Copyright 2008, Google Inc.
 
 - Extension for writing and using C++ mock classes from Google Mock -

apl-dev-env.sh

@@ -120,7 +120,7 @@ function apl-check-core {  # Run make for the core build with -Werror
 function apl-test-core {  # Run unit tests in the core build
     (
         apl-switch-to-build-directory build $@ && \
-        $CMAKE -DBUILD_TESTS=ON -DCOVERAGE=OFF .. && \
+        $CMAKE -DBUILD_TESTS=ON  -DCOVERAGE=OFF .. && \
         make -j$APL_BUILD_PROCS && \
         unit/unittest
     )

apl-viewhost-code-check.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+#
+# Find the use of properties that have "kPropIn" set but are being
+# used in a view host. Properties marked as kPropIn are provided by,
+# and set by the document.  kPropIn properties are intended for
+# APLCoreEngine use only.  These properties are used to derive kPropOut
+# properties which can be safely consumed by the view host.
+# 
+# This scripts expects that you start in a view host git repository
+# and the APLCoreEngine repository is next to it.
+
+INPUT_ONLY_PROPS=$(cd ../APLCoreEngine && \
+         git grep -E '\{.*kPropIn[^O]' | \
+         cut -d ',' -f 1 | \
+         grep -o -E '(k\w+)' | \
+         sort | \
+         uniq | \
+         paste -d '|' -s - -)
+
+git grep -E "${INPUT_ONLY_PROPS}"
+

aplcore/CMakeLists.txt

@@ -1,128 +1,74 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file 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.
+
 set(CMAKE_CXX_STANDARD 11)
 
 # Set template depth to support pegtl on older versions of clang.
 if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ftemplate-depth=1024")
 endif()
 
-add_library(apl STATIC
-        src/action/action.cpp
-        src/action/animateitemaction.cpp
-        src/action/autopageaction.cpp
-        src/action/arrayaction.cpp
-        src/action/extensioneventaction.cpp
-        src/action/documentaction.cpp
-        src/action/openurlaction.cpp
-        src/action/scrolltoaction.cpp
-        src/action/sequentialaction.cpp
-        src/action/setpageaction.cpp
-        src/action/speakitemaction.cpp
-        src/action/speaklistaction.cpp
-        src/animation/animatedproperty.cpp
-        src/animation/easing.cpp
-        src/command/arraycommand.cpp
-        src/command/commandfactory.cpp
-        src/command/commandproperties.cpp
-        src/command/corecommand.cpp
-        src/command/extensioneventcommand.cpp
-        src/command/documentcommand.cpp
-        src/component/actionablecomponent.cpp
-        src/component/component.cpp
-        src/component/componentproperties.cpp
-        src/component/containercomponent.cpp
-        src/component/corecomponent.cpp
-        src/component/framecomponent.cpp
-        src/component/imagecomponent.cpp
-        src/component/pagercomponent.cpp
-        src/component/scrollablecomponent.cpp
-        src/component/scrollviewcomponent.cpp
-        src/component/sequencecomponent.cpp
-        src/component/textcomponent.cpp
-        src/component/textmeasurement.cpp
-        src/component/touchwrappercomponent.cpp
-        src/component/vectorgraphiccomponent.cpp
-        src/component/videocomponent.cpp
-        src/component/yogaproperties.cpp
-        src/content/aplversion.cpp
-        src/content/content.cpp
-        src/content/directive.cpp
-        src/content/importrequest.cpp
-        src/content/jsondata.cpp
-        src/content/metrics.cpp
-        src/content/package.cpp
-        src/content/rootconfig.cpp
-        src/content/viewport.cpp
-        src/datagrammar/boundsymbol.cpp
-        src/datagrammar/functions.cpp
-        src/datagrammar/node.cpp
-        src/datasource/datasource.cpp
-        src/datasource/dynamicindexlistdatasourceprovider.cpp
-        src/datasource/offsetindexdatasourceconnection.cpp
-        src/engine/arrayify.cpp
-        src/engine/binding.cpp
-        src/engine/builder.cpp
-        src/engine/context.cpp
-        src/engine/componentdependant.cpp
-        src/engine/contextdependant.cpp
-        src/engine/contextobject.cpp
-        src/engine/dependant.cpp
-        src/engine/evaluate.cpp
-        src/engine/event.cpp
-        src/engine/extensionmanager.cpp
-        src/engine/focusmanager.cpp
-        src/engine/hovermanager.cpp
-        src/engine/info.cpp
-        src/engine/keyboardmanager.cpp
-        src/engine/parameterarray.cpp
-        src/engine/propdef.cpp
-        src/engine/properties.cpp
-        src/engine/resources.cpp
-        src/engine/rootcontext.cpp
-        src/engine/rootcontextdata.cpp
-        src/engine/state.cpp
-        src/engine/styleinstance.cpp
-        src/engine/styledefinition.cpp
-        src/engine/styles.cpp
-        src/livedata/livearrayobject.cpp
-        src/livedata/livedataobject.cpp
-        src/livedata/livedatamanager.cpp
-        src/livedata/layoutrebuilder.cpp
-        src/livedata/livearray.cpp
-        src/livedata/livemap.cpp
-        src/livedata/livemapobject.cpp
-        src/graphic/graphic.cpp
-        src/graphic/graphiccontent.cpp
-        src/graphic/graphicdependant.cpp
-        src/graphic/graphicelement.cpp
-        src/graphic/graphicproperties.cpp
-        src/primitives/color.cpp
-        src/primitives/dimension.cpp
-        src/primitives/filter.cpp
-        src/primitives/functions.cpp
-        src/primitives/gradient.cpp
-        src/primitives/keyboard.cpp
-        src/primitives/mediasource.cpp
-        src/primitives/radii.cpp
-        src/primitives/rect.cpp
-        src/primitives/symbolreferencemap.cpp
-        src/primitives/styledtext.cpp
-        src/primitives/timefunctions.cpp
-        src/primitives/timegrammar.cpp
-        src/primitives/transform.cpp
-        src/primitives/transform2d.cpp
-        src/primitives/object.cpp
-        src/scaling/metricstransform.cpp
-        src/scaling/scalingcalculator.cpp
-        src/time/sequencer.cpp
-        src/utils/log.cpp
-        src/utils/path.cpp
-        src/utils/session.cpp
-        src/utils/telemetry.cpp)
+include(target_sources_local.cmake)
+
+# Check for the presence of GIT
+# Code from: https://gist.github.com/rkitover
+find_package(Git)
+if (GIT_FOUND)
+    execute_process(COMMAND "${GIT_EXECUTABLE}" describe --tags --dirty
+            WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+            RESULT_VARIABLE res
+            OUTPUT_VARIABLE CORE_REPOSITORY_VERSION
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+            ERROR_QUIET)
+    if (res)
+        message(VERBOSE "Git repository not found in directory ${CMAKE_CURRENT_SOURCE_DIR}, not setting version info")
+        set(CORE_REPOSITORY_VERSION "unknown")
+    endif()
+else()
+    message(VERBOSE "Git program not found (${GIT_FOUND}), not setting version info")
+    SET(CORE_REPOSITORY_VERSION "unknown")
+endif()
+
+message(STATUS "Core Repository Version ${CORE_REPOSITORY_VERSION}")
+configure_file(buildTimeConstants.cpp.in buildTimeConstants.cpp @ONLY)
+
+add_library(apl STATIC ${CMAKE_CURRENT_BINARY_DIR}/buildTimeConstants.cpp)
+
+add_subdirectory(src/action)
+add_subdirectory(src/animation)
+add_subdirectory(src/command)
+add_subdirectory(src/component)
+add_subdirectory(src/content)
+add_subdirectory(src/datagrammar)
+add_subdirectory(src/datasource)
+add_subdirectory(src/engine)
+add_subdirectory(src/extension)
+add_subdirectory(src/graphic)
+add_subdirectory(src/livedata)
+add_subdirectory(src/primitives)
+add_subdirectory(src/scaling)
+add_subdirectory(src/time)
+add_subdirectory(src/touch)
+add_subdirectory(src/utils)
+
+set(PUBLIC_HEADER_LIST
+        include/apl/apl.h
+        include/apl/dynamicdata.h)
 
 set_target_properties(apl PROPERTIES
                       VERSION "${PROJECT_VERSION}"
                       SOVERSION 1
-                      PUBLIC_HEADER include/apl/apl.h)
+                      PUBLIC_HEADER "${PUBLIC_HEADER_LIST}")
 
 configure_file(apl.pc.in apl.pc @ONLY)
 target_include_directories(apl PRIVATE include)
@@ -167,4 +113,4 @@ target_link_libraries(
         # Links the target library to the log library included in the NDK.
         ${log-lib})
 
-endif(ANDROID)
+endif(ANDROID)

aplcore/buildTimeConstants.cpp.in

@@ -0,0 +1,20 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file 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.
+ */
+
+namespace apl {
+
+const char *sCoreRepositoryVersion = "@CORE_REPOSITORY_VERSION@";
+
+} // namespace apl

aplcore/include/apl/action/action.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License").
  * You may not use this file except in compliance with the License.
@@ -47,7 +47,7 @@ union ActionResolveArg {
 /**
  * Common base class of action contracts.
  */
-class Action : public std::enable_shared_from_this<Action>, private Counter<Action>, public UserData {
+class Action : public std::enable_shared_from_this<Action>, private Counter<Action>, public UserData<Action> {
 
 public:
     /**
@@ -100,7 +100,7 @@ class Action : public std::enable_shared_from_this<Action>, private Counter<Acti
 
 public:
     Action(const TimersPtr& timers, TerminateFunc terminate = nullptr);
-    ~Action();
+    virtual ~Action();
 
     Action& operator=(const Action&) = delete;
     Action(const Action&) = delete;
@@ -145,9 +145,7 @@ class Action : public std::enable_shared_from_this<Action>, private Counter<Acti
      */
     void addTerminateCallback(TerminateFunc terminateFunc);
 
-    /*
-     * Convenience methods to introspect current state
-     */
+     // Convenience methods to introspect current state
 
     /**
      * @return True if this action is still pending and has not resolved or terminated.
@@ -177,6 +175,9 @@ class Action : public std::enable_shared_from_this<Action>, private Counter<Acti
 
     friend streamer& operator<<(streamer&, Action&);
 
+protected:
+    virtual void onFinish() {}
+
 private:
     void doResolve();
 

aplcore/include/apl/action/animateitemaction.h

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License").
  * You may not use this file except in compliance with the License.
@@ -16,26 +16,22 @@
 #ifndef _APL_ANIMATE_ITEM_ACTION_H
 #define _APL_ANIMATE_ITEM_ACTION_H
 
-#include "apl/action/action.h"
-#include "apl/animation/animatedproperty.h"
+#include "apl/action/resourceholdingaction.h"
+#include "apl/animation/easing.h"
 
 namespace apl {
 
+class AnimatedProperty;
 class CoreCommand;
 
 /**
  * Handle running an AnimateItem command
  */
-class AnimateItemAction : public Action {
+class AnimateItemAction : public ResourceHoldingAction {
 public:
     static std::shared_ptr<AnimateItemAction> make(const TimersPtr& timers,
                                                const std::shared_ptr<CoreCommand>& command,
-                                               bool fastMode)
-    {
-        auto ptr = std::make_shared<AnimateItemAction>(timers, command, fastMode);
-        ptr->start();
-        return ptr;
-    }
+                                               bool fastMode);
 
     AnimateItemAction(const TimersPtr& timers,
                       const std::shared_ptr<CoreCommand>& command,
@@ -56,7 +52,7 @@ class AnimateItemAction : public Action {
     const int mRepeatCount;
     const int mRepeatMode;
     const bool mFastMode;
-    Easing mEasing;
+    std::shared_ptr<Easing> mEasing;
 };