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/common/stage.h>
26 #include <dali/public-api/common/vector-wrapper.h>
27 #include <dali/public-api/actors/actor.h>
28 #include <dali/public-api/object/base-object.h>
29 #include <dali/public-api/object/property-map.h>
30 #include <dali/public-api/render-tasks/render-task.h>
31 #include <dali-toolkit/devel-api/visual-factory/transition-data.h>
32 #include <dali/integration-api/debug.h>
35 #include <dali-toolkit/devel-api/builder/json-parser.h>
36 #include <dali-toolkit/devel-api/builder/builder.h>
37 #include <dali-toolkit/internal/builder/builder-declarations.h>
39 // Warning messages usually displayed
40 #define DALI_SCRIPT_WARNING(format, args...) \
41 DALI_LOG_WARNING("Script:" format, ## args)
43 // Info messages are usually debug build
44 #define DALI_SCRIPT_INFO(format, args...) \
45 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::General, "Script:" format, ## args)
47 // Info Verbose need to be swiched on in gFilterScript filter constructor (by default set to General)
48 #define DALI_SCRIPT_VERBOSE(format, args...) \
49 DALI_LOG_INFO(Dali::Toolkit::Internal::gFilterScript, Debug::Verbose, "Script:" format, ## args)
65 #if defined(DEBUG_ENABLED)
66 extern Dali::Integration::Log::Filter* gFilterScript;
73 * @copydoc Toolkit::Builder
75 class Builder : public Dali::BaseObject
82 * @copydoc Toolkit::Builder::LoadFromString
84 void LoadFromString( const std::string &data,
85 Dali::Toolkit::Builder::UIFormat rep = Dali::Toolkit::Builder::JSON );
88 * @copydoc Toolkit::Builder::AddConstants
90 void AddConstants( const Property::Map& map );
93 * @copydoc Toolkit::Builder::AddConstant
95 void AddConstant( const std::string& key, const Property::Value& value );
98 * @copydoc Toolkit::Builder::GetConstants
100 const Property::Map& GetConstants() const;
103 * @copydoc Toolkit::Builder::GetConstant
105 const Property::Value& GetConstant( const std::string& key ) const;
108 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName );
110 Animation CreateAnimation( const std::string& animationName );
113 * @copydoc Toolkit::Builder::CreateAnimation( const std::string& animationName, const Property::Map& map );
115 Animation CreateAnimation( const std::string& animationName, const Property::Map& map );
118 * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,Dali::Actor);
120 Animation CreateAnimation( const std::string& animationName, Dali::Actor sourceActor );
123 * @copydoc Toolkit::Builder::CreateAnimation( const std::string&,const Property::Map&, Dali::Actor);
125 Animation CreateAnimation( const std::string& animationName, const Property::Map& map, Dali::Actor sourceActor );
128 * @copydoc Toolkit::Builder::Create( const std::string& templateName );
130 BaseHandle Create( const std::string& templateName );
133 * @copydoc Toolkit::Builder::Create( const std::string& templateName, const Property::Map& map );
135 BaseHandle Create( const std::string& templateName, const Property::Map& map );
138 * @copydoc Toolkit::Builder::CreateFromJson( const std::string& json );
140 BaseHandle CreateFromJson( const std::string& json );
143 * @copydoc Toolkit::Builder::ApplyFromJson( Handle& handle, const std::string& json );
145 bool ApplyFromJson( Handle& handle, const std::string& json );
148 * @copydoc Toolkit::Builder::ApplyStyle
150 bool ApplyStyle( const std::string& styleName, Handle& handle );
153 * @copydoc Toolkit::Builder::AddActors
155 void AddActors( Actor toActor );
158 * @copydoc Toolkit::Builder::AddActors
160 void AddActors( const std::string §ionName, Actor toActor );
163 * @copydoc Toolkit::Builder::CreateRenderTask
165 void CreateRenderTask( const std::string &name );
168 * @copydoc Toolkit::Builder::GetFrameBufferImage
170 FrameBufferImage GetFrameBufferImage( const std::string &name );
173 * @copydoc Toolkit::Builder::GetFrameBufferImage
175 FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
178 * @copydoc Toolkit::Builder::GetPath
180 Path GetPath( const std::string &name );
183 * @copydoc Toolkit::Builder::GetPathConstrainer
185 Dali::PathConstrainer GetPathConstrainer( const std::string& name );
188 * Check if a given constrainer is of type PathConstrainer
189 * @param[in] name The name of the constrainer
190 * @return True if constainer is of type PathConstrainer, False otherwise
193 bool IsPathConstrainer( const std::string& name );
196 * @copydoc Toolkit::Builder::GetLinearConstrainer
198 Dali::LinearConstrainer GetLinearConstrainer( const std::string& name );
201 * Check if a given constrainer is of type LinearConstrainer
202 * @param[in] name The name of the constrainer
203 * @return True if constainer is of type LinearConstrainer, False otherwise
206 bool IsLinearConstrainer( const std::string& name );
209 * @copydoc Toolkit::Builder::QuitSignal
211 Toolkit::Builder::BuilderSignalType& QuitSignal();
214 * Emits the quit signal
216 void EmitQuitSignal();
223 typedef std::vector<const char*> KeyStack;
224 typedef std::vector< TreeNode::KeyNodePair > MappingsLut;
225 typedef struct{ std::string name; Dali::LinearConstrainer linearConstrainer; } LinearConstrainerEntry;
226 typedef std::vector<LinearConstrainerEntry> LinearConstrainerLut;
227 typedef struct{ std::string name; Dali::PathConstrainer pathConstrainer; } PathConstrainerEntry;
228 typedef std::vector<PathConstrainerEntry> PathConstrainerLut;
229 typedef std::map<const std::string, Path> PathLut;
230 typedef std::map<const std::string, FrameBufferImage> ImageLut;
234 Builder(const Builder&);
237 Builder& operator=(const Builder& rhs);
239 void LoadConstants( const TreeNode& root, Property::Map& intoMap );
241 Animation CreateAnimation( const std::string& animationName,
242 const Replacement& replacement,
243 Dali::Actor sourceActor );
245 BaseHandle Create( const std::string& templateName,
246 const Replacement& constant );
248 BaseHandle DoCreate( const TreeNode& root,
249 const TreeNode& node,
251 const Replacement& replacements );
253 void SetupTask( RenderTask& task,
254 const Toolkit::TreeNode& node,
255 const Replacement& replacement );
257 bool ApplyStyle( const std::string& styleName,
259 const Replacement& replacement);
261 void ApplyAllStyleProperties( const TreeNode& root,
262 const TreeNode& node,
263 Dali::Handle& handle,
264 const Replacement& constant );
266 void ApplyProperties( const TreeNode& root,
267 const TreeNode& node,
268 Dali::Handle& handle,
269 const Replacement& constant );
271 void ApplyStylesByActor( const TreeNode& root,
272 const TreeNode& node,
273 Dali::Handle& handle,
274 const Replacement& constant );
276 void SetProperties( const TreeNode& node,
278 const Replacement& constant );
281 * Find the key in the mapping table, if it's present, then generate
282 * a property value for it (of the given type if available),
283 * recursing as necessary, and stopping if any cycles are detected.
285 * @param[in] mappingRoot The JSON node containing the mappings
286 * @param[in] theKey The key to search for
287 * @param[in] propertyType The property type if known, or NONE
288 * @param[in,out] value The string value to test and write back to.
290 bool GetPropertyMap( const TreeNode& mappingRoot,
292 Property::Type propertyType,
293 Property::Value& value );
295 void SetCustomProperties( const TreeNode& node,
297 const Replacement& constant,
298 const std::string& childName,
299 Property::AccessMode accessMode );
302 * Find the key in the mapping table, if it's present, then generate
303 * a property value for it (of the given type if available),
304 * recursing as necessary, and stopping if any cycles are detected.
306 * @param[in] mappingRoot The JSON node containing the mappings
307 * @param[in] theKey The key to search for
308 * @param[in,out] keyStack the stack of visited keys
309 * @param[in] propertyType The property type if known, or NONE
310 * @param[in,out] value The string value to test and write back to.
312 bool RecursePropertyMap( const TreeNode& mappingRoot,
315 Property::Type propertyType,
316 Property::Value& value );
320 * Tests if the value is a string delimited by <>. If it is, then it attempts to
321 * change the value to the mapping from a matching key in the mappings table.
322 * @param[in] mappingRoot The JSON node containing the mappings
323 * @param[in,out] keyStack the stack of visited keys
324 * @param[in,out] value The string value to test and write back to.
325 * @return true if the value was converted, false otherwise.
327 bool ConvertChildValue( const TreeNode& mappingRoot,
329 Property::Value& value );
332 Toolkit::JsonParser mParser;
333 ImageLut mFrameBufferImageLut;
335 PathConstrainerLut mPathConstrainerLut;
336 LinearConstrainerLut mLinearConstrainerLut;
337 SlotDelegate<Builder> mSlotDelegate;
338 Property::Map mReplacementMap;
339 MappingsLut mCompleteMappings;
340 Toolkit::Builder::BuilderSignalType mQuitSignal;
343 } // namespace Internal
345 inline Internal::Builder& GetImpl(Dali::Toolkit::Builder& obj)
347 DALI_ASSERT_ALWAYS(obj);
349 Dali::BaseObject& handle = obj.GetBaseObject();
351 return static_cast<Internal::Builder&>(handle);
354 inline const Internal::Builder& GetImpl(const Dali::Toolkit::Builder& obj)
356 DALI_ASSERT_ALWAYS(obj);
358 const Dali::BaseObject& handle = obj.GetBaseObject();
360 return static_cast<const Internal::Builder&>(handle);
363 } // namespace Toolkit
367 #endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__