-#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
{
/**
* @copydoc Toolkit::Builder::AddConstants
*/
- void AddConstants( const PropertyValueMap& map );
+ void AddConstants( const Property::Map& map );
/**
* @copydoc Toolkit::Builder::AddConstant
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
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& animationName, Dali::Actor searchRoot );
+ * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,Dali::Actor);
*/
- Animation CreateAnimation( const std::string& animationName, Dali::Actor searchRoot );
+ Animation CreateAnimation( const std::string& animationName, Dali::Actor sourceActor );
/**
- * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor searchRoot );
+ * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,const Property::Map&, Dali::Actor);
*/
- Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor searchRoot );
+ 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
void AddActors( const std::string §ionName, Actor toActor );
/**
- * @copydoc Toolkit::Builder::GetAnimation
- */
- Animation GetAnimation( const std::string &name ) const;
-
- /**
* @copydoc Toolkit::Builder::CreateRenderTask
*/
void CreateRenderTask( const std::string &name );
/**
- * @copydoc Toolkit::Builder::GetShaderEffect
+ * @copydoc Toolkit::Builder::GetPath
*/
- ShaderEffect GetShaderEffect( const std::string &name );
+ Path GetPath( const std::string &name );
/**
- * @copydoc Toolkit::Builder::GetShaderEffect
+ * @copydoc Toolkit::Builder::GetPathConstrainer
*/
- ShaderEffect GetShaderEffect( const std::string &name, const Replacement& constant );
+ 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 );
+ 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::GetFrameBufferImage
+ * @copydoc Toolkit::Builder::QuitSignal
*/
- FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
+ 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;
+
+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 );
- typedef std::map<const std::string, ShaderEffect> ShaderEffectLut;
- ShaderEffectLut mShaderEffectLut;
+ BaseHandle Create( const std::string& templateName,
+ const Replacement& constant );
- SlotDelegate<Builder> mSlotDelegate;
+ BaseHandle DoCreate( const TreeNode& root,
+ const TreeNode& node,
+ Actor parent,
+ const Replacement& replacements );
- PropertyValueMap mReplacementMap;
+ void SetupTask( RenderTask& task,
+ const Toolkit::TreeNode& node,
+ const Replacement& replacement );
- BaseHandle Create( const OptionalChild& optionalStyles, const TreeNode& node, const TreeNode& root, Actor parent,
- const Replacement& replacement );
+ bool ApplyStyle( const std::string& styleName,
+ Handle& handle,
+ const Replacement& replacement);
- void LoadConstants();
+ void ApplyAllStyleProperties( const TreeNode& root,
+ const TreeNode& node,
+ Dali::Handle& handle,
+ const Replacement& constant );
- void ApplyStyle( const std::string& styleName, Handle& handle, const Replacement& replacement);
+ void RecordStyles( const char* styleName,
+ const TreeNode& node,
+ Dali::Handle& handle,
+ const Replacement& replacements );
- Animation CreateAnimation( const std::string& animationName, const Replacement& replacement, Dali::Actor searchRoot );
+ void RecordStyle( StylePtr style,
+ const TreeNode& node,
+ Dali::Handle& handle,
+ const Replacement& replacements );
- BaseHandle CreateFromStyle( const std::string& styleName, const Replacement& replacement );
+ void RecordTransitions( const TreeNode::KeyNodePair& keyValue,
+ Property::Array& transitions,
+ const Replacement& replacements );
+
+ void RecordTransitionData( const TreeNode::KeyNodePair& keyNode,
+ Toolkit::TransitionData& transitionData,
+ const Replacement& replacements );
+
+ void ApplyProperties( const TreeNode& root,
+ const TreeNode& node,
+ Dali::Handle& handle,
+ const Replacement& constant );
+
+ void ApplySignals( const TreeNode& root,
+ const TreeNode& node,
+ Dali::Handle& handle );
+
+ void ApplyStylesByActor( const TreeNode& root,
+ const TreeNode& node,
+ Dali::Handle& handle,
+ const Replacement& constant );
+
+ void SetProperties( const TreeNode& node,
+ Handle& handle,
+ const Replacement& constant );
+
+ 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;
+ 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
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__
+#endif // DALI_TOOLKIT_INTERNAL_BUILDER_H