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/integration-api/debug.h>
34 #include <dali-toolkit/devel-api/builder/json-parser.h>
35 #include <dali-toolkit/devel-api/builder/builder.h>
36 #include <dali-toolkit/internal/builder/builder-declarations.h>
37 #include <dali-toolkit/internal/builder/style.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 * Lookup the stylename in builder. If it's found in the parse tree,
155 * @param[in] styleName The style name to search for
156 * @return true if the stylename exists
158 bool LookupStyleName( const std::string& styleName );
161 * Lookup the stylename in the recorded Styles - if it exists,
162 * performs a shallow copy to the passed in style and returns true.
163 * Otherwise it returns false.
165 * @param[in] styleName The stylename to search for
166 * @return A const pointer to the style object
168 const StylePtr GetStyle( const std::string& styleName );
171 * @copydoc Toolkit::Builder::AddActors
173 void AddActors( Actor toActor );
176 * @copydoc Toolkit::Builder::AddActors
178 void AddActors( const std::string §ionName, Actor toActor );
181 * @copydoc Toolkit::Builder::CreateRenderTask
183 void CreateRenderTask( const std::string &name );
186 * @copydoc Toolkit::Builder::GetFrameBufferImage
188 FrameBufferImage GetFrameBufferImage( const std::string &name );
191 * @copydoc Toolkit::Builder::GetFrameBufferImage
193 FrameBufferImage GetFrameBufferImage( const std::string &name, const Replacement& constant );
196 * @copydoc Toolkit::Builder::GetPath
198 Path GetPath( const std::string &name );
201 * @copydoc Toolkit::Builder::GetPathConstrainer
203 Dali::PathConstrainer GetPathConstrainer( const std::string& name );
206 * Check if a given constrainer is of type PathConstrainer
207 * @param[in] name The name of the constrainer
208 * @return True if constainer is of type PathConstrainer, False otherwise
211 bool IsPathConstrainer( const std::string& name );
214 * @copydoc Toolkit::Builder::GetLinearConstrainer
216 Dali::LinearConstrainer GetLinearConstrainer( const std::string& name );
219 * Check if a given constrainer is of type LinearConstrainer
220 * @param[in] name The name of the constrainer
221 * @return True if constainer is of type LinearConstrainer, False otherwise
224 bool IsLinearConstrainer( const std::string& name );
227 * @copydoc Toolkit::Builder::QuitSignal
229 Toolkit::Builder::BuilderSignalType& QuitSignal();
232 * Emits the quit signal
234 void EmitQuitSignal();
242 typedef std::vector<const char*> KeyStack;
243 typedef std::vector< TreeNode::KeyNodePair > MappingsLut;
244 typedef struct{ std::string name; Dali::LinearConstrainer linearConstrainer; } LinearConstrainerEntry;
245 typedef std::vector<LinearConstrainerEntry> LinearConstrainerLut;
246 typedef struct{ std::string name; Dali::PathConstrainer pathConstrainer; } PathConstrainerEntry;
247 typedef std::vector<PathConstrainerEntry> PathConstrainerLut;
248 typedef std::map<const std::string, Path> PathLut;
249 typedef std::map<const std::string, FrameBufferImage> ImageLut;
253 Builder(const Builder&);
256 Builder& operator=(const Builder& rhs);
258 void LoadConstants( const TreeNode& root, Property::Map& intoMap );
260 Animation CreateAnimation( const std::string& animationName,
261 const Replacement& replacement,
262 Dali::Actor sourceActor );
264 BaseHandle Create( const std::string& templateName,
265 const Replacement& constant );
267 BaseHandle DoCreate( const TreeNode& root,
268 const TreeNode& node,
270 const Replacement& replacements );
272 void SetupTask( RenderTask& task,
273 const Toolkit::TreeNode& node,
274 const Replacement& replacement );
276 bool ApplyStyle( const std::string& styleName,
278 const Replacement& replacement);
280 void ApplyAllStyleProperties( const TreeNode& root,
281 const TreeNode& node,
282 Dali::Handle& handle,
283 const Replacement& constant );
285 void RecordStyles( const char* styleName,
286 const TreeNode& node,
287 Dali::Handle& handle,
288 const Replacement& replacements );
290 void RecordStyle( StylePtr style,
291 const TreeNode& node,
292 Dali::Handle& handle,
293 const Replacement& replacements );
295 void RecordTransitions( const TreeNode::KeyNodePair& keyValue,
296 Property::Array& transitions,
297 const Replacement& replacements );
299 void RecordTransitionData( const TreeNode::KeyNodePair& keyNode,
300 Toolkit::TransitionData& transitionData,
301 const Replacement& replacements );
303 void ApplyProperties( const TreeNode& root,
304 const TreeNode& node,
305 Dali::Handle& handle,
306 const Replacement& constant );
308 void ApplySignals( const TreeNode& root,
309 const TreeNode& node,
310 Dali::Handle& handle );
312 void ApplyStylesByActor( const TreeNode& root,
313 const TreeNode& node,
314 Dali::Handle& handle,
315 const Replacement& constant );
317 void SetProperties( const TreeNode& node,
319 const Replacement& constant );
321 bool MapToTargetProperty( Handle& propertyObject,
322 const std::string& key,
323 const TreeNode& node,
324 const Replacement& constant,
325 Property::Index& index,
326 Property::Value& value );
329 * Find the key in the mapping table, if it's present, then generate
330 * a property value for it (of the given type if available),
331 * recursing as necessary, and stopping if any cycles are detected.
333 * @param[in] mappingRoot The JSON node containing the mappings
334 * @param[in] theKey The key to search for
335 * @param[in] propertyType The property type if known, or NONE
336 * @param[in,out] value The string value to test and write back to.
338 bool GetPropertyMap( const TreeNode& mappingRoot,
340 Property::Type propertyType,
341 Property::Value& value );
343 void SetCustomProperties( const TreeNode& node,
345 const Replacement& constant,
346 const std::string& childName,
347 Property::AccessMode accessMode );
350 * Find the key in the mapping table, if it's present, then generate
351 * a property value for it (of the given type if available),
352 * recursing as necessary, and stopping if any cycles are detected.
354 * @param[in] mappingRoot The JSON node containing the mappings
355 * @param[in] theKey The key to search for
356 * @param[in,out] keyStack the stack of visited keys
357 * @param[in] propertyType The property type if known, or NONE
358 * @param[in,out] value The string value to test and write back to.
360 bool RecursePropertyMap( const TreeNode& mappingRoot,
363 Property::Type propertyType,
364 Property::Value& value );
368 * Tests if the value is a string delimited by <>. If it is, then it attempts to
369 * change the value to the mapping from a matching key in the mappings table.
370 * @param[in] mappingRoot The JSON node containing the mappings
371 * @param[in,out] keyStack the stack of visited keys
372 * @param[in,out] value The string value to test and write back to.
373 * @return true if the value was converted, false otherwise.
375 bool ConvertChildValue( const TreeNode& mappingRoot,
377 Property::Value& value );
380 Toolkit::JsonParser mParser;
381 ImageLut mFrameBufferImageLut;
383 PathConstrainerLut mPathConstrainerLut;
384 LinearConstrainerLut mLinearConstrainerLut;
385 SlotDelegate<Builder> mSlotDelegate;
386 Property::Map mReplacementMap;
387 MappingsLut mCompleteMappings;
388 Dictionary<StylePtr> mStyles; // State based styles
389 Toolkit::Builder::BuilderSignalType mQuitSignal;
392 } // namespace Internal
394 inline Internal::Builder& GetImpl(Dali::Toolkit::Builder& obj)
396 DALI_ASSERT_ALWAYS(obj);
398 Dali::BaseObject& handle = obj.GetBaseObject();
400 return static_cast<Internal::Builder&>(handle);
403 inline const Internal::Builder& GetImpl(const Dali::Toolkit::Builder& obj)
405 DALI_ASSERT_ALWAYS(obj);
407 const Dali::BaseObject& handle = obj.GetBaseObject();
409 return static_cast<const Internal::Builder&>(handle);
412 } // namespace Toolkit
416 #endif // __DALI_TOOLKIT_INTERNAL_BUILDER_H__