Purge underscored header file barriers
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / builder / builder-impl.h
old mode 100644 (file)
new mode 100755 (executable)
index 3378eee..2eb4a2b
@@ -1,46 +1,52 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_BUILDER_H__
-#define __DALI_TOOLKIT_INTERNAL_BUILDER_H__
-
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License 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 DALI_TOOLKIT_INTERNAL_BUILDER_H
+#define DALI_TOOLKIT_INTERNAL_BUILDER_H
+
+/*
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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.
+ *
+ */
 
 // EXTERNAL INCLUDES
 #include <string>
 #include <list>
 #include <map>
-#include <boost/property_tree/ptree.hpp>
-#include <dali/dali.h>
+#include <dali/public-api/common/stage.h>
+#include <dali/public-api/common/vector-wrapper.h>
+#include <dali/public-api/actors/actor.h>
+#include <dali/public-api/object/base-object.h>
+#include <dali/public-api/object/property-map.h>
+#include <dali/public-api/render-tasks/render-task.h>
 #include <dali/integration-api/debug.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/builder/json-parser.h>
-#include <dali-toolkit/public-api/builder/builder.h>
+#include <dali-toolkit/devel-api/builder/json-parser.h>
+#include <dali-toolkit/devel-api/builder/builder.h>
 #include <dali-toolkit/internal/builder/builder-declarations.h>
+#include <dali-toolkit/internal/builder/style.h>
 
 // Warning messages usually displayed
-#define DALI_SCRIPT_WARNING(format, args...) \
-  DALI_LOG_WARNING("Script:" format, ## args)
+#define DALI_SCRIPT_WARNING(format, ...) \
+  DALI_LOG_WARNING("Script:" format, ## __VA_ARGS__)
 
 // Info messages are usually debug build
-#define DALI_SCRIPT_INFO(format, args...) \
-  DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::General, "Script:" format, ## args)
+#define DALI_SCRIPT_INFO(format, ...) \
+  DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::General, "Script:" format, ## __VA_ARGS__)
 
 // Info Verbose need to be swiched on in gFilterScript filter constructor (by default set to General)
-#define DALI_SCRIPT_VERBOSE(format, args...) \
-  DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::Verbose, "Script:" format, ## args)
+#define DALI_SCRIPT_VERBOSE(format, ...) \
+  DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::Verbose, "Script:" format, ## __VA_ARGS__)
 
 namespace Dali
 {
@@ -81,7 +87,7 @@ public:
   /**
    * @copydoc Toolkit::Builder::AddConstants
    */
-  void AddConstants( const PropertyValueMap& map );
+  void AddConstants( const Property::Map& map );
 
   /**
    * @copydoc Toolkit::Builder::AddConstant
@@ -89,9 +95,14 @@ public:
   void AddConstant( const std::string& key, const Property::Value& value );
 
   /**
+   * @copydoc Toolkit::Builder::GetConfigurations
+   */
+  const Property::Map& GetConfigurations() const;
+
+  /**
    * @copydoc Toolkit::Builder::GetConstants
    */
-  const PropertyValueMap& GetConstants() const;
+  const Property::Map& GetConstants() const;
 
   /**
    * @copydoc Toolkit::Builder::GetConstant
@@ -104,9 +115,9 @@ public:
   Animation CreateAnimation( const std::string& animationName );
 
   /**
-   * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const PropertyValueMap& map );
+   * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const Property::Map& map );
    */
-  Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map );
+  Animation CreateAnimation( const std::string& animationName, const Property::Map& map );
 
   /**
    * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,Dali::Actor);
@@ -114,44 +125,52 @@ public:
   Animation CreateAnimation( const std::string& animationName, Dali::Actor sourceActor );
 
   /**
-   * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,const PropertyValueMap&,Dali::Actor);
+   * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,const Property::Map&, Dali::Actor);
    */
-  Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor sourceActor );
+  Animation CreateAnimation( const std::string& animationName, const Property::Map& map, Dali::Actor sourceActor );
 
   /**
-   * @copydoc Toolkit::Builder::CreateFromStyle( const std::string& styleName );
+   * @copydoc Toolkit::Builder::Create( const std::string& templateName );
    */
-  BaseHandle CreateFromStyle( const std::string& styleName );
+  BaseHandle Create( const std::string& templateName );
 
   /**
-   * @copydoc Toolkit::Builder::CreateFromStyle( const std::string& styleName, const PropertyValueMap& map );
+   * @copydoc Toolkit::Builder::Create( const std::string& templateName, const Property::Map& map );
    */
-  BaseHandle CreateFromStyle( const std::string& styleName, const PropertyValueMap& map );
+  BaseHandle Create( const std::string& templateName, const Property::Map& map );
 
   /**
-   * @copydoc Toolkit::Builder::GetFont
+   * @copydoc Toolkit::Builder::CreateFromJson( const std::string& json );
    */
-  Font GetFont(const std::string &name) const;
+  BaseHandle CreateFromJson( const std::string& json );
 
   /**
-   * @copydoc Toolkit::Builder::GetTextStyle
+   * @copydoc Toolkit::Builder::ApplyFromJson( Handle& handle, const std::string& json );
    */
-  TextStyle GetTextStyle(const std::string &name) const;
+  bool ApplyFromJson(  Handle& handle, const std::string& json );
 
   /**
-   * @copydoc Toolkit::Builder::GetImage
+   * @copydoc Toolkit::Builder::ApplyStyle
    */
-  Image GetImage(const std::string &name) const;
+  bool ApplyStyle( const std::string& styleName, Handle& handle );
 
   /**
-   * @copydoc Toolkit::Builder::GetActor
+   * Lookup the stylename in builder. If it's found in the parse tree,
+   * then return true.
+   * @param[in] styleName The style name to search for
+   * @return true if the stylename exists
    */
-  Actor GetActor( const std::string &name ) const;
+  bool LookupStyleName( const std::string& styleName );
 
   /**
-   * @copydoc Toolkit::Builder::ApplyStyle
+   * Lookup the stylename in the recorded Styles - if it exists,
+   * performs a shallow copy to the passed in style and returns true.
+   * Otherwise it returns false.
+
+   * @param[in] styleName The stylename to search for
+   * @return A const pointer to the style object
    */
-  void ApplyStyle( const std::string& styleName, Handle& handle );
+  const StylePtr GetStyle( const std::string& styleName );
 
   /**
    * @copydoc Toolkit::Builder::AddActors
@@ -164,74 +183,218 @@ public:
   void AddActors( const std::string &sectionName, Actor toActor );
 
   /**
-   * @copydoc Toolkit::Builder::GetAnimation
+   * @copydoc Toolkit::Builder::CreateRenderTask
    */
-  Animation GetAnimation( const std::string &name ) const;
+  void CreateRenderTask( const std::string &name );
 
   /**
-   * @copydoc Toolkit::Builder::CreateRenderTask
+   * @copydoc Toolkit::Builder::GetFrameBufferImage
    */
-  void CreateRenderTask( const std::string &name );
+  FrameBufferImage GetFrameBufferImage( const std::string &name );
 
   /**
-   * @copydoc Toolkit::Builder::GetShaderEffect
+   * @copydoc Toolkit::Builder::GetFrameBufferImage
    */
-  ShaderEffect GetShaderEffect( const std::string &name );
+  FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
 
   /**
-   * @copydoc Toolkit::Builder::GetShaderEffect
+   * @copydoc Toolkit::Builder::GetPath
    */
-  ShaderEffect GetShaderEffect( const std::string &name, const Replacement& constant );
+  Path GetPath( const std::string &name );
 
   /**
-   * @copydoc Toolkit::Builder::GetFrameBufferImage
+   * @copydoc Toolkit::Builder::GetPathConstrainer
    */
-  FrameBufferImage GetFrameBufferImage( const std::string &name );
+  Dali::PathConstrainer GetPathConstrainer( const std::string& name );
+
+  /*
+   * Check if a given constrainer is of type PathConstrainer
+   * @param[in] name The name of the constrainer
+   * @return True if constainer is of type PathConstrainer, False otherwise
+   *
+   */
+  bool IsPathConstrainer( const std::string& name );
 
   /**
-   * @copydoc Toolkit::Builder::GetFrameBufferImage
+   * @copydoc Toolkit::Builder::GetLinearConstrainer
    */
-  FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
+  Dali::LinearConstrainer GetLinearConstrainer( const std::string& name );
+
+  /*
+   * Check if a given constrainer is of type LinearConstrainer
+   * @param[in] name The name of the constrainer
+   * @return True if constainer is of type LinearConstrainer, False otherwise
+   *
+   */
+  bool IsLinearConstrainer( const std::string& name );
+
+  /**
+   * @copydoc Toolkit::Builder::QuitSignal
+   */
+  Toolkit::Builder::BuilderSignalType& QuitSignal();
 
   /**
-   * @copydoc Toolkit::Builder::GetTopLevelActors
+   * Emits the quit signal
    */
-  ActorContainer GetTopLevelActors( void ) const;
+  void EmitQuitSignal();
+
 
 protected:
 
   virtual ~Builder();
 
 private:
+  typedef std::vector<const char*> KeyStack;
+  typedef std::vector< TreeNode::KeyNodePair > MappingsLut;
+  typedef struct{ std::string name; Dali::LinearConstrainer linearConstrainer; } LinearConstrainerEntry;
+  typedef std::vector<LinearConstrainerEntry> LinearConstrainerLut;
+  typedef struct{ std::string name; Dali::PathConstrainer pathConstrainer; } PathConstrainerEntry;
+  typedef std::vector<PathConstrainerEntry> PathConstrainerLut;
+  typedef std::map<const std::string, Path> PathLut;
+  typedef std::map<const std::string, FrameBufferImage> ImageLut;
+
+private:
   // Undefined
   Builder(const Builder&);
+
+  // Undefined
   Builder& operator=(const Builder& rhs);
 
-  void SetupTask( RenderTask& task, const Toolkit::TreeNode& node, const Replacement& replacement );
+  void LoadConstants( const TreeNode& root, Property::Map& intoMap );
 
-private:
-  Toolkit::JsonParser mParser;
+  void LoadConfiguration( const TreeNode& root, Property::Map& intoMap );
 
-  typedef std::map<const std::string, FrameBufferImage> ImageLut;
-  ImageLut mFrameBufferImageLut;
+  Animation CreateAnimation( const std::string& animationName,
+                             const Replacement& replacement,
+                             Dali::Actor        sourceActor );
+
+  BaseHandle Create( const std::string& templateName,
+                     const Replacement& constant );
+
+  BaseHandle DoCreate( const TreeNode&    root,
+                       const TreeNode&    node,
+                       Actor              parent,
+                       const Replacement& replacements );
+
+  void SetupTask( RenderTask&              task,
+                  const Toolkit::TreeNode& node,
+                  const Replacement&       replacement );
+
+  bool ApplyStyle( const std::string& styleName,
+                   Handle&            handle,
+                   const Replacement& replacement);
+
+  void ApplyAllStyleProperties( const TreeNode&    root,
+                                const TreeNode&    node,
+                                Dali::Handle&      handle,
+                                const Replacement& constant );
+
+  void RecordStyles( const char*        styleName,
+                     const TreeNode&    node,
+                     Dali::Handle&      handle,
+                     const Replacement& replacements );
 
-  typedef std::map<const std::string, ShaderEffect> ShaderEffectLut;
-  ShaderEffectLut mShaderEffectLut;
+  void RecordStyle( StylePtr           style,
+                    const TreeNode&    node,
+                    Dali::Handle&      handle,
+                    const Replacement& replacements );
 
-  SlotDelegate<Builder> mSlotDelegate;
+  void RecordTransitions( const TreeNode::KeyNodePair& keyValue,
+                          Property::Array& transitions,
+                          const Replacement& replacements );
 
-  PropertyValueMap mReplacementMap;
+  void RecordTransitionData( const TreeNode::KeyNodePair& keyNode,
+                             Toolkit::TransitionData& transitionData,
+                             const Replacement& replacements );
 
-  BaseHandle Create( const OptionalChild& optionalStyles, const TreeNode& node, const TreeNode& root, Actor parent,
-                     const Replacement& replacement );
+  void ApplyProperties( const TreeNode&    root,
+                        const TreeNode&    node,
+                        Dali::Handle&      handle,
+                        const Replacement& constant );
 
-  void LoadConstants();
+  void ApplySignals( const TreeNode& root,
+                     const TreeNode& node,
+                     Dali::Handle& handle );
 
-  void ApplyStyle( const std::string& styleName, Handle& handle, const Replacement& replacement);
+  void ApplyStylesByActor( const TreeNode&    root,
+                           const TreeNode&    node,
+                           Dali::Handle&      handle,
+                           const Replacement& constant );
 
-  Animation CreateAnimation( const std::string& animationName, const Replacement& replacement, Dali::Actor sourceActor );
+  void SetProperties( const TreeNode&    node,
+                      Handle&            handle,
+                      const Replacement& constant );
 
-  BaseHandle CreateFromStyle( const std::string& styleName, const Replacement& replacement );
+  bool MapToTargetProperty( Handle&            propertyObject,
+                            const std::string& key,
+                            const TreeNode&    node,
+                            const Replacement& constant,
+                            Property::Index&   index,
+                            Property::Value&   value );
+
+  /**
+   * Find the key in the mapping table, if it's present, then generate
+   * a property value for it (of the given type if available),
+   * recursing as necessary, and stopping if any cycles are detected.
+   *
+   * @param[in] mappingRoot The JSON node containing the mappings
+   * @param[in] theKey The key to search for
+   * @param[in] propertyType The property type if known, or NONE
+   * @param[in,out] value The string value to test and write back to.
+   */
+  bool GetPropertyMap( const TreeNode&  mappingRoot,
+                       const char*      theKey,
+                       Property::Type   propertyType,
+                       Property::Value& value );
+
+  void SetCustomProperties( const TreeNode&      node,
+                            Handle&              handle,
+                            const Replacement&   constant,
+                            const std::string&   childName,
+                            Property::AccessMode accessMode );
+
+  /**
+   * Find the key in the mapping table, if it's present, then generate
+   * a property value for it (of the given type if available),
+   * recursing as necessary, and stopping if any cycles are detected.
+   *
+   * @param[in] mappingRoot The JSON node containing the mappings
+   * @param[in] theKey The key to search for
+   * @param[in,out] keyStack the stack of visited keys
+   * @param[in] propertyType The property type if known, or NONE
+   * @param[in,out] value The string value to test and write back to.
+   */
+  bool RecursePropertyMap( const TreeNode&  mappingRoot,
+                           KeyStack&        keyStack,
+                           const char*      theKey,
+                           Property::Type   propertyType,
+                           Property::Value& value );
+
+
+  /**
+   * Tests if the value is a string delimited by <>. If it is, then it attempts to
+   * change the value to the mapping from a matching key in the mappings table.
+   * @param[in] mappingRoot The JSON node containing the mappings
+   * @param[in,out] keyStack the stack of visited keys
+   * @param[in,out] value The string value to test and write back to.
+   * @return true if the value was converted, false otherwise.
+   */
+  bool ConvertChildValue( const TreeNode& mappingRoot,
+                          KeyStack& keyStack,
+                          Property::Value& value );
+
+private:
+  Toolkit::JsonParser                 mParser;
+  ImageLut                            mFrameBufferImageLut;
+  PathLut                             mPathLut;
+  PathConstrainerLut                  mPathConstrainerLut;
+  LinearConstrainerLut                mLinearConstrainerLut;
+  SlotDelegate<Builder>               mSlotDelegate;
+  Property::Map                       mReplacementMap;
+  Property::Map                       mConfigurationMap;
+  MappingsLut                         mCompleteMappings;
+  Dictionary<StylePtr>                mStyles; // State based styles
+  Toolkit::Builder::BuilderSignalType mQuitSignal;
 };
 
 } // namespace Internal
@@ -258,4 +421,4 @@ inline const Internal::Builder& GetImpl(const Dali::Toolkit::Builder& obj)
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__
+#endif // DALI_TOOLKIT_INTERNAL_BUILDER_H