APL-CORE: January 2021 Release of the APL 1.5 compliant core engine (1.5.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,38 @@
 # Changelog
 
+## [1.5.0]
+
+This release adds support for version 1.5 of the APL specification.
+
+### Added
+
+- New Math functions: Math.isNaN, Math.isInf and Math.isFinite
+- New Array functions: Array.indexOf, Array.range, Array.slice
+- New String function: String.length
+- Report visible children from Sequence and GridSequence components
+- DropShadow filter for AVG
+- Accessibility: add fontScale, screenMode, screenReader, and timing properties to environment.
+- Accessibility: Added actions and role to base component.
+- Extensions: extensions can provide custom image filters
+- Support bind in AVG
+- Report when the visual context is dirty
+- Alpha feature: handle scrolling and paging in the APL Core library
+- Alpha feature: scroll snapping
+- Alpha feature: custom transitions for Pager
+
+### Changed
+
+- Updated reported APL version to 1.5
+- Accessibility: Update accessibilityLabel property to be dynamic
+- Update AVG inflation to support the multi-child inflation rules
+- Update gesture processing to consider applied transforms
+- Bug fixes
+- Build improvements
+
+See README.md for more details on alpha features.
+
+
+
 ## [1.4.1]
 
 This is a bug fix release of apl-core-library.

CMakeLists.txt

@@ -20,6 +20,10 @@ project(APLCoreEngine
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+if (NOT APL_CORE_DIR)
+    set(APL_CORE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+endif()
+
 include(options.cmake)
 
 set(APL_PATCH_DIR "${CMAKE_CURRENT_SOURCE_DIR}/patches")

NOTICE.txt

@@ -18,24 +18,4 @@ limitations under the License.
 THIRD PARTY COMPONENTS
 **********************
 
-This software includes third party software subject to the following
-copyrights:
-
-- JSON parsing for C++ from RapidJSON - Copyright (C) 2015 THL A29 Limited,
-a Tencent company, and Milo Yip.
-
-- Parsing Expression Grammar Template Library -
-Copyright (c) 2007-2019 Dr. Colin Hirsch and Daniel Frey.
-
-- Yoga - Copyright (c) Facebook, Inc. and its affiliates.
-
-- C++ test framework from Google Test - Copyright 2008, Google Inc.
-
-- Extension for writing and using C++ mock classes from Google Mock -
-Copyright 2008, Google Inc.
-
-NOTE: Other license terms may apply to certain, identified software files
-contained within or distributed with the accompanying software if such terms
-are included in the directory containing the accompanying software. Such
-other license terms will then apply in lieu of the terms of the software
-license above.
+This software includes third party software. See THIRD-PARTY-NOTICES.txt for details.

README.md

@@ -12,7 +12,8 @@ create Alexa experiences with visual renderings on their device or platform in
 the programming language of their choice.
 
 # Architecture
-<pre>                              APL Core Library
+```
+                              APL Core Library
 
          +----------------------------------------------------------+
          | +---------------+  +----------------+ +----------------+ |
@@ -44,7 +45,8 @@ the programming language of their choice.
  |     OS1 Native|  | Cross Platform|    | Cross Platform|  |    OS4 Native |
  |     View Host |  | View Host     |    | View Host     |  |    View Host  |
  |               |  |               |    |               |  |               |
- +---------------+  +---------------+    +---------------+  +---------------+</pre>
+ +---------------+  +---------------+    +---------------+  +---------------+
+ ```
 
 Above is shown the high-level architecture of the APL Core Library, showing 
 its interaction with a few possible view host implementations.

THIRD-PARTY-NOTICES.txt

@@ -0,0 +1,198 @@
+** googletest; version 1.8.1 -- https://github.com/google/googletest
+Copyright 2005-2009, 2013, Google Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+------
+
+** rapidjson; version 1.1.0 -- https://github.com/miloyip/rapidjson
+Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights
+reserved.
+
+MIT License
+
+Tencent is pleased to support the open source community by making RapidJSON
+available.
+
+Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights
+reserved.
+
+If you have downloaded a copy of the RapidJSON binary from Tencent, please note
+that the RapidJSON binary is licensed under the MIT License.
+If you have downloaded a copy of the RapidJSON source code from Tencent, please
+note that RapidJSON source code is licensed under the MIT License, except for
+the third-party components listed below which are subject to different license
+terms. Your integration of RapidJSON into your own projects may require
+compliance with the MIT License, as well as the other licenses applicable to
+the third-party components included within RapidJSON. To avoid the problematic
+JSON license in your own projects, it's sufficient to exclude the
+bin/jsonchecker/ directory, as it's the only code under the JSON license.
+A copy of the MIT License is included in this file.
+
+Other dependencies and licenses:
+
+Open Source Software Licensed Under the BSD License:
+--------------------------------------------------------------------
+
+The msinttypes r29
+Copyright (c) 2006-2013 Alexander Chemeris
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+* Neither the name of copyright holder nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Open Source Software Licensed Under the JSON License:
+--------------------------------------------------------------------
+
+json.org
+Copyright (c) 2002 JSON.org
+All Rights Reserved.
+
+JSON_checker
+Copyright (c) 2002 JSON.org
+All Rights Reserved.
+
+
+Terms of the JSON License:
+---------------------------------------------------
+
+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 shall be used for Good, not Evil.
+
+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.
+
+
+Terms of the MIT License:
+--------------------------------------------------------------------
+
+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
+
+------
+
+** yoga 1.16; version 1.16.0 -- https://yogalayout.com/
+Copyright (c) Facebook, Inc. and its affiliates.
+
+MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+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.
+
+------
+
+** pegtl 2.8; version 2.8.1 -- 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
+
+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.

aplcore/CMakeLists.txt

@@ -63,6 +63,7 @@ add_subdirectory(src/utils)
 
 set(PUBLIC_HEADER_LIST
         include/apl/apl.h
+        ${PROJECT_BINARY_DIR}/aplcore/include/apl/apl_config.h
         include/apl/dynamicdata.h)
 
 set_target_properties(apl PROPERTIES
@@ -114,3 +115,14 @@ target_link_libraries(
         ${log-lib})
 
 endif(ANDROID)
+
+install(TARGETS apl
+        ARCHIVE DESTINATION lib
+        LIBRARY DESTINATION lib
+        PUBLIC_HEADER DESTINATION include/apl)
+install(DIRECTORY ${PROJECT_SOURCE_DIR}/aplcore/include/apl
+        DESTINATION include
+        FILES_MATCHING PATTERN "*.h")
+install(FILES ${YOGA_LIB}
+        DESTINATION lib)
+

aplcore/include/apl/action/action.h

@@ -47,7 +47,9 @@ union ActionResolveArg {
 /**
  * Common base class of action contracts.
  */
-class Action : public std::enable_shared_from_this<Action>, private Counter<Action>, public UserData<Action> {
+class Action : public std::enable_shared_from_this<Action>,
+               public Counter<Action>,
+               public UserData<Action> {
 
 public:
     /**
@@ -189,12 +191,6 @@ class Action : public std::enable_shared_from_this<Action>, private Counter<Acti
     timeout_id mTimeoutId;
     const TimersPtr mTimers;
     ActionResolveArg mArgument;
-
-#ifdef DEBUG_MEMORY_USE
-public:
-    using Counter<Action>::itemsDelta;
-#endif
-
 };
 
 /**

aplcore/include/apl/action/animatedscrollaction.h

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+
+#ifndef _APL_ANIMATED_SCROLL_ACTION_H
+#define _APL_ANIMATED_SCROLL_ACTION_H
+
+#include "apl/action/resourceholdingaction.h"
+
+namespace apl {
+
+class CoreCommand;
+class Easing;
+
+class AnimatedScrollAction : public ResourceHoldingAction {
+protected:
+    AnimatedScrollAction(const TimersPtr& timers,
+                         const ContextPtr& context,
+                         const CoreComponentPtr& scrollable);
+
+    void scroll(bool vertical, const Point& position);
+
+    CoreComponentPtr mContainer;
+
+private:
+    void advance(float from, float to);
+
+    EasingPtr mEasing;
+    ActionPtr mCurrentAction;
+};
+
+
+} // namespace apl
+
+#endif //_APL_ANIMATED_SCROLL_ACTION_H

aplcore/include/apl/action/animateitemaction.h

@@ -52,7 +52,7 @@ class AnimateItemAction : public ResourceHoldingAction {
     const int mRepeatCount;
     const int mRepeatMode;
     const bool mFastMode;
-    std::shared_ptr<Easing> mEasing;
+    EasingPtr mEasing;
 };