1 #ifndef __DALI_TOOLKIT_INTERNAL_BUILDER_H__
2 #define __DALI_TOOLKIT_INTERNAL_BUILDER_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.0 (the License);
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://floralicense.org/license/
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an AS IS BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
24 #include <boost/property_tree/ptree.hpp>
25 #include <dali/dali.h>
26 #include <dali/integration-api/debug.h>
29 #include <dali-toolkit/public-api/builder/json-parser.h>
30 #include <dali-toolkit/public-api/builder/builder.h>
31 #include <dali-toolkit/internal/builder/builder-declarations.h>
33 // Warning messages usually displayed
34 #define DALI_SCRIPT_WARNING(format, args...) \
35 DALI_LOG_WARNING("Script:" format, ## args)
37 // Info messages are usually debug build
38 #define DALI_SCRIPT_INFO(format, args...) \
39 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::General, "Script:" format, ## args)
41 // Info Verbose need to be swiched on in gFilterScript filter constructor (by default set to General)
42 #define DALI_SCRIPT_VERBOSE(format, args...) \
43 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::Verbose, "Script:" format, ## args)
59 #if defined(DEBUG_ENABLED)
60 extern Dali::Integration::Log::Filter* gFilterScript;
67 * @copydoc Toolkit::Builder
69 class Builder : public Dali::BaseObject
76 * @copydoc Toolkit::Builder::LoadFromString
78 void LoadFromString( const std::string &data,
79 Dali::Toolkit::Builder::UIFormat rep = Dali::Toolkit::Builder::JSON );
82 * @copydoc Toolkit::Builder::AddConstants
84 void AddConstants( const PropertyValueMap& map );
87 * @copydoc Toolkit::Builder::AddConstant
89 void AddConstant( const std::string& key, const Property::Value& value );
92 * @copydoc Toolkit::Builder::GetConstants
94 const PropertyValueMap& GetConstants() const;
97 * @copydoc Toolkit::Builder::GetConstant
99 const Property::Value& GetConstant( const std::string& key ) const;
102 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName );
104 Animation CreateAnimation( const std::string& animationName );
107 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const PropertyValueMap& map );
109 Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map );
112 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, Dali::Actor searchRoot );
114 Animation CreateAnimation( const std::string& animationName, Dali::Actor searchRoot );
117 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor searchRoot );
119 Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor searchRoot );
122 * @copydoc Toolkit::Builder::CreateFromStyle( const std::string& styleName );
124 BaseHandle CreateFromStyle( const std::string& styleName );
127 * @copydoc Toolkit::Builder::CreateFromStyle( const std::string& styleName, const PropertyValueMap& map );
129 BaseHandle CreateFromStyle( const std::string& styleName, const PropertyValueMap& map );
132 * @copydoc Toolkit::Builder::GetFont
134 Font GetFont(const std::string &name) const;
137 * @copydoc Toolkit::Builder::GetTextStyle
139 TextStyle GetTextStyle(const std::string &name) const;
142 * @copydoc Toolkit::Builder::GetImage
144 Image GetImage(const std::string &name) const;
147 * @copydoc Toolkit::Builder::GetActor
149 Actor GetActor( const std::string &name ) const;
152 * @copydoc Toolkit::Builder::ApplyStyle
154 void ApplyStyle( const std::string& styleName, Handle& handle );
157 * @copydoc Toolkit::Builder::AddActors
159 void AddActors( Actor toActor );
162 * @copydoc Toolkit::Builder::AddActors
164 void AddActors( const std::string §ionName, Actor toActor );
167 * @copydoc Toolkit::Builder::GetAnimation
169 Animation GetAnimation( const std::string &name ) const;
172 * @copydoc Toolkit::Builder::CreateRenderTask
174 void CreateRenderTask( const std::string &name );
177 * @copydoc Toolkit::Builder::GetShaderEffect
179 ShaderEffect GetShaderEffect( const std::string &name );
182 * @copydoc Toolkit::Builder::GetShaderEffect
184 ShaderEffect GetShaderEffect( const std::string &name, const Replacement& constant );
187 * @copydoc Toolkit::Builder::GetFrameBufferImage
189 FrameBufferImage GetFrameBufferImage( const std::string &name );
192 * @copydoc Toolkit::Builder::GetFrameBufferImage
194 FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
197 * @copydoc Toolkit::Builder::GetTopLevelActors
199 ActorContainer GetTopLevelActors( void ) const;
207 Builder(const Builder&);
208 Builder& operator=(const Builder& rhs);
210 void SetupTask( RenderTask& task, const Toolkit::TreeNode& node, const Replacement& replacement );
213 Toolkit::JsonParser mParser;
215 typedef std::map<const std::string, FrameBufferImage> ImageLut;
216 ImageLut mFrameBufferImageLut;
218 typedef std::map<const std::string, ShaderEffect> ShaderEffectLut;
219 ShaderEffectLut mShaderEffectLut;
221 SlotDelegate<Builder> mSlotDelegate;
223 PropertyValueMap mReplacementMap;
225 BaseHandle Create( const OptionalChild& optionalStyles, const TreeNode& node, const TreeNode& root, Actor parent,
226 const Replacement& replacement );
228 void LoadConstants();
230 void ApplyStyle( const std::string& styleName, Handle& handle, const Replacement& replacement);
232 Animation CreateAnimation( const std::string& animationName, const Replacement& replacement, Dali::Actor searchRoot );
234 BaseHandle CreateFromStyle( const std::string& styleName, const Replacement& replacement );
237 } // namespace Internal
239 inline Internal::Builder& GetImpl(Dali::Toolkit::Builder& obj)
241 DALI_ASSERT_ALWAYS(obj);
243 Dali::BaseObject& handle = obj.GetBaseObject();
245 return static_cast<Internal::Builder&>(handle);
248 inline const Internal::Builder& GetImpl(const Dali::Toolkit::Builder& obj)
250 DALI_ASSERT_ALWAYS(obj);
252 const Dali::BaseObject& handle = obj.GetBaseObject();
254 return static_cast<const Internal::Builder&>(handle);
257 } // namespace Toolkit
261 #endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__