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 Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/public-api/actors/actor.h>
26 #include <dali/public-api/object/base-object.h>
27 #include <dali/integration-api/debug.h>
30 #include <dali-toolkit/public-api/builder/json-parser.h>
31 #include <dali-toolkit/public-api/builder/builder.h>
32 #include <dali-toolkit/internal/builder/builder-declarations.h>
34 // Warning messages usually displayed
35 #define DALI_SCRIPT_WARNING(format, args...) \
36 DALI_LOG_WARNING("Script:" format, ## args)
38 // Info messages are usually debug build
39 #define DALI_SCRIPT_INFO(format, args...) \
40 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::General, "Script:" format, ## args)
42 // Info Verbose need to be swiched on in gFilterScript filter constructor (by default set to General)
43 #define DALI_SCRIPT_VERBOSE(format, args...) \
44 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::Verbose, "Script:" format, ## args)
60 #if defined(DEBUG_ENABLED)
61 extern Dali::Integration::Log::Filter* gFilterScript;
68 * @copydoc Toolkit::Builder
70 class Builder : public Dali::BaseObject
77 * @copydoc Toolkit::Builder::LoadFromString
79 void LoadFromString( const std::string &data,
80 Dali::Toolkit::Builder::UIFormat rep = Dali::Toolkit::Builder::JSON );
83 * @copydoc Toolkit::Builder::AddConstants
85 void AddConstants( const Property::Map& map );
88 * @copydoc Toolkit::Builder::AddConstant
90 void AddConstant( const std::string& key, const Property::Value& value );
93 * @copydoc Toolkit::Builder::GetConstants
95 const Property::Map& GetConstants() const;
98 * @copydoc Toolkit::Builder::GetConstant
100 const Property::Value& GetConstant( const std::string& key ) const;
103 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName );
105 Animation CreateAnimation( const std::string& animationName );
108 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const Property::Map& map );
110 Animation CreateAnimation( const std::string& animationName, const Property::Map& map );
113 * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,Dali::Actor);
115 Animation CreateAnimation( const std::string& animationName, Dali::Actor sourceActor );
118 * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,const Property::Map&, Dali::Actor);
120 Animation CreateAnimation( const std::string& animationName, const Property::Map& map, Dali::Actor sourceActor );
123 * @copydoc Toolkit::Builder::Create( const std::string& templateName );
125 BaseHandle Create( const std::string& templateName );
128 * @copydoc Toolkit::Builder::Create( const std::string& templateName, const Property::Map& map );
130 BaseHandle Create( const std::string& templateName, const Property::Map& map );
133 * @copydoc Toolkit::Builder::CreateFromJson( const std::string& json );
135 BaseHandle CreateFromJson( const std::string& json );
138 * @copydoc Toolkit::Builder::ApplyFromJson( Handle& handle, const std::string& json );
140 bool ApplyFromJson( Handle& handle, const std::string& json );
143 * @copydoc Toolkit::Builder::ApplyStyle
145 bool ApplyStyle( const std::string& styleName, Handle& handle );
148 * @copydoc Toolkit::Builder::AddActors
150 void AddActors( Actor toActor );
153 * @copydoc Toolkit::Builder::AddActors
155 void AddActors( const std::string §ionName, Actor toActor );
158 * @copydoc Toolkit::Builder::CreateRenderTask
160 void CreateRenderTask( const std::string &name );
163 * @copydoc Toolkit::Builder::GetShaderEffect
165 ShaderEffect GetShaderEffect( const std::string &name );
168 * @copydoc Toolkit::Builder::GetShaderEffect
170 ShaderEffect GetShaderEffect( const std::string &name, const Replacement& constant );
173 * @copydoc Toolkit::Builder::GetFrameBufferImage
175 FrameBufferImage GetFrameBufferImage( const std::string &name );
178 * @copydoc Toolkit::Builder::GetFrameBufferImage
180 FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
183 * @copydoc Toolkit::Builder::GetPath
185 Path GetPath( const std::string &name );
187 * @copydoc Toolkit::Builder::QuitSignal
189 Toolkit::Builder::BuilderSignalType& QuitSignal();
192 * Emits the quit signal
194 void EmitQuitSignal();
202 Builder(const Builder&);
203 Builder& operator=(const Builder& rhs);
205 void SetupTask( RenderTask& task, const Toolkit::TreeNode& node, const Replacement& replacement );
208 Toolkit::JsonParser mParser;
210 typedef std::map<const std::string, FrameBufferImage> ImageLut;
211 ImageLut mFrameBufferImageLut;
213 typedef std::map<const std::string, ShaderEffect> ShaderEffectLut;
214 ShaderEffectLut mShaderEffectLut;
216 typedef std::map<const std::string, Path> PathLut;
219 SlotDelegate<Builder> mSlotDelegate;
221 Property::Map mReplacementMap;
223 BaseHandle Create( const std::string& templateName, const Replacement& constant );
225 BaseHandle DoCreate( const TreeNode& root, const TreeNode& node, Actor parent, const Replacement& replacements );
227 void LoadConstants( const TreeNode& root, Property::Map& intoMap );
229 void LoadIncludes( const std::string& data );
231 bool ApplyStyle( const std::string& styleName, Handle& handle, const Replacement& replacement);
233 Animation CreateAnimation( const std::string& animationName, const Replacement& replacement, Dali::Actor sourceActor );
235 void ApplyProperties( const TreeNode& root, const TreeNode& node,
236 Dali::Handle& handle, const Replacement& constant );
238 void ApplyStylesByActor( const TreeNode& root, const TreeNode& node,
239 Dali::Handle& handle, const Replacement& constant );
241 void ApplyAllStyleProperties( const TreeNode& root, const TreeNode& node,
242 Dali::Handle& handle, const Replacement& constant );
244 void SetProperties( const TreeNode& node, Handle& handle, const Replacement& constant );
246 Toolkit::Builder::BuilderSignalType mQuitSignal;
249 } // namespace Internal
251 inline Internal::Builder& GetImpl(Dali::Toolkit::Builder& obj)
253 DALI_ASSERT_ALWAYS(obj);
255 Dali::BaseObject& handle = obj.GetBaseObject();
257 return static_cast<Internal::Builder&>(handle);
260 inline const Internal::Builder& GetImpl(const Dali::Toolkit::Builder& obj)
262 DALI_ASSERT_ALWAYS(obj);
264 const Dali::BaseObject& handle = obj.GetBaseObject();
266 return static_cast<const Internal::Builder&>(handle);
269 } // namespace Toolkit
273 #endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__