2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "style-manager-impl.h"
21 #include <dali/devel-api/common/singleton-service.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/adaptor-framework/application.h>
24 #include <dali/public-api/object/type-registry-helper.h>
25 #include <dali/public-api/object/type-registry.h>
28 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
29 #include <dali-toolkit/internal/builder/builder-impl.h>
30 #include <dali-toolkit/internal/feedback/feedback-style.h>
31 #include <dali-toolkit/public-api/controls/control-impl.h>
32 #include <dali-toolkit/public-api/controls/control.h>
33 #include <dali-toolkit/public-api/styling/style-manager.h>
37 //const char* LANDSCAPE_QUALIFIER = "landscape";
38 const char* PORTRAIT_QUALIFIER = "portrait";
39 const char* FONT_SIZE_QUALIFIER = "fontsize";
41 const char* DEFAULT_THEME_FILE_NAME = "dali-toolkit-default-theme.json";
43 const char* PACKAGE_PATH_KEY = "PACKAGE_PATH";
44 const char* APPLICATION_RESOURCE_PATH_KEY = "APPLICATION_RESOURCE_PATH";
46 const char* DEFAULT_TOOLKIT_PACKAGE_PATH = "/toolkit/";
48 #if defined(DEBUG_ENABLED)
49 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_STYLE");
64 BaseHandle handle = StyleManager::Get();
68 SingletonService singletonService(SingletonService::Get());
71 Toolkit::StyleManager manager = Toolkit::StyleManager(new Internal::StyleManager());
72 singletonService.Register(typeid(manager), manager);
80 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::StyleManager, Dali::BaseHandle, Create, true)
81 DALI_TYPE_REGISTRATION_END()
85 Toolkit::StyleManager StyleManager::Get()
87 Toolkit::StyleManager manager;
89 SingletonService singletonService(SingletonService::Get());
92 // Check whether the style manager is already created
93 Dali::BaseHandle handle = singletonService.GetSingleton(typeid(Toolkit::StyleManager));
96 // If so, downcast the handle of singleton
97 manager = Toolkit::StyleManager(dynamic_cast<StyleManager*>(handle.GetObjectPtr()));
104 StyleManager::StyleManager()
105 : mDefaultFontSize(-1),
106 mDefaultFontFamily(""),
107 mDefaultThemeFilePath(),
108 mFeedbackStyle(nullptr)
110 // Add theme builder constants
111 const std::string dataReadOnlyDir = AssetManager::GetDaliDataReadOnlyPath();
112 mThemeBuilderConstants[PACKAGE_PATH_KEY] = dataReadOnlyDir + DEFAULT_TOOLKIT_PACKAGE_PATH;
113 mThemeBuilderConstants[APPLICATION_RESOURCE_PATH_KEY] = Application::GetResourcePath();
115 mStyleMonitor = StyleMonitor::Get();
118 mStyleMonitor.StyleChangeSignal().Connect(this, &StyleManager::StyleMonitorChange);
119 mDefaultFontSize = mStyleMonitor.GetDefaultFontSize();
122 // Set the full path for the default style theme.
123 const std::string styleDirPath = AssetManager::GetDaliStylePath();
124 mDefaultThemeFilePath = styleDirPath + DEFAULT_THEME_FILE_NAME;
126 // Sound & haptic style
127 mFeedbackStyle = new FeedbackStyle();
130 StyleManager::~StyleManager()
132 delete mFeedbackStyle;
135 void StyleManager::ApplyTheme(const std::string& themeFile)
140 void StyleManager::ApplyDefaultTheme()
142 SetTheme(mDefaultThemeFilePath);
145 const std::string& StyleManager::GetDefaultFontFamily() const
147 return mDefaultFontFamily;
150 void StyleManager::SetStyleConstant(const std::string& key, const Property::Value& value)
152 mStyleBuilderConstants[key] = value;
155 bool StyleManager::GetStyleConstant(const std::string& key, Property::Value& valueOut)
157 Property::Value* value = mStyleBuilderConstants.Find(key);
167 void StyleManager::ApplyThemeStyle(Toolkit::Control control)
176 ApplyStyle(mThemeBuilder, control);
180 void StyleManager::ApplyThemeStyleAtInit(Toolkit::Control control)
182 ApplyThemeStyle(control);
186 mFeedbackStyle->ObjectCreated(control);
190 void StyleManager::ApplyStyle(Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName)
192 bool builderReady = false;
194 // First look in the cache
195 Toolkit::Builder builder = FindCachedBuilder(jsonFileName);
202 // Merge theme and style constants
203 Property::Map constants(mThemeBuilderConstants);
204 constants.Merge(mStyleBuilderConstants);
207 builder = CreateBuilder(constants);
209 if(LoadJSON(builder, jsonFileName))
211 CacheBuilder(builder, jsonFileName);
216 // Apply the style to the control
219 builder.ApplyStyle(styleName, control);
223 Toolkit::StyleManager::StyleChangedSignalType& StyleManager::StyleChangedSignal()
225 return mStyleChangedSignal;
228 Toolkit::StyleManager::StyleChangedSignalType& StyleManager::ControlStyleChangeSignal()
230 return mControlStyleChangeSignal;
233 void StyleManager::SetTheme(const std::string& themeFile)
235 bool themeLoaded = false;
236 bool loading = false;
238 // If we haven't loaded a theme, or the stored theme file is empty, or
239 // the previously loaded theme is different to the requested theme,
240 // first reset the builder and load the default theme.
241 if(!mThemeBuilder || mThemeFile.empty() || mThemeFile.compare(themeFile) != 0)
244 mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
245 themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath); // Sets themeLoaded to true if theme exists
248 if(themeFile.compare(mDefaultThemeFilePath) != 0)
250 // The theme is different to the default: Merge it
252 themeLoaded |= LoadJSON(mThemeBuilder, themeFile);
257 mThemeFile = themeFile;
261 // We've successfully loaded the theme file
264 mFeedbackStyle->StyleChanged(mThemeFile, StyleChange::THEME_CHANGE);
267 EmitStyleChangeSignals(StyleChange::THEME_CHANGE);
271 // We tried to load a theme, but it failed. Ensure the builder is reset
272 mThemeBuilder.Reset();
278 const Property::Map StyleManager::GetConfigurations()
280 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On entry, mThemeBuilder: " << (bool(mThemeBuilder) ? "Created" : "Empty") << " mThemeFile: " << mThemeFile);
282 Property::Map result;
285 result = mThemeBuilder.GetConfigurations();
289 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations() Loading default theme");
291 bool themeLoaded = false;
293 mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
295 // Load default theme because this is first try to load stylesheet.
296 themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath);
297 mThemeFile = mDefaultThemeFilePath;
301 result = mThemeBuilder.GetConfigurations();
303 DALI_LOG_STREAM(gLogFilter, Debug::Concise, " themeLoaded" << (themeLoaded ? "success" : "failure"));
306 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On exit, result Count: " << (result.Count() != 0));
307 DALI_LOG_STREAM(gLogFilter, Debug::Verbose, " result: " << result);
312 bool StyleManager::LoadFile(const std::string& filename, std::string& stringOut)
314 DALI_ASSERT_DEBUG(0 != filename.length());
316 // as toolkit is platform agnostic, it cannot load files from filesystem
317 // ask style monitor to load the style sheet
320 return mStyleMonitor.LoadThemeFile(filename, stringOut);
326 Toolkit::Builder StyleManager::CreateBuilder(const Property::Map& constants)
328 Toolkit::Builder builder = Toolkit::Builder::New();
329 builder.AddConstants(constants);
334 bool StyleManager::LoadJSON(Toolkit::Builder builder, const std::string& jsonFilePath)
336 std::string fileString;
337 if(LoadFile(jsonFilePath, fileString))
339 builder.LoadFromString(fileString);
344 DALI_LOG_WARNING("Error loading file '%s'\n", jsonFilePath.c_str());
349 static void CollectQualifiers(std::vector<std::string>& qualifiersOut)
351 // Append the relevant qualifier for orientation
352 // int orientation = 0; // Get the orientation from the system
355 Getting orientation from the system, and determine Qualifie LANDSCAPE or PORTRAIT
356 orientation 0, 180 : PORTRAIT_QUALIFIER (default)
357 orientation 90, 270 : LANDSCAPE_QUALIFIER
360 qualifiersOut.push_back(std::string(PORTRAIT_QUALIFIER));
364 * @brief Construct a qualified style name out of qualifiers
366 * A qualifed style name will be in the format: style-qualifier0-qualifier1-qualifierN
368 * @param[in] styleName The root name of the style
369 * @param[in] qualifiers List of qualifier names
370 * @param[out] qualifiedStyleOut The qualified style name
372 static void BuildQualifiedStyleName(
373 const std::string& styleName,
374 const std::vector<std::string>& qualifiers,
375 std::string& qualifiedStyleOut)
377 qualifiedStyleOut.append(styleName);
379 for(std::vector<std::string>::const_iterator it = qualifiers.begin(),
380 itEnd = qualifiers.end();
384 const std::string& str = *it;
386 qualifiedStyleOut.append("-");
387 qualifiedStyleOut.append(str);
391 static bool GetStyleNameForControl(Toolkit::Builder builder, Toolkit::Control control, std::string& styleName)
393 styleName = control.GetStyleName();
395 if(styleName.empty())
397 styleName = control.GetTypeName();
400 // Apply the style after choosing the correct actual style (e.g. landscape or portrait)
401 std::vector<std::string> qualifiers;
402 CollectQualifiers(qualifiers);
405 std::string qualifiedStyleName;
408 qualifiedStyleName.clear();
409 BuildQualifiedStyleName(styleName, qualifiers, qualifiedStyleName);
411 // Break if style found or we have tried the root style name (qualifiers is empty)
412 if(GetImpl(builder).LookupStyleName(qualifiedStyleName))
417 if(qualifiers.size() == 0)
421 // Remove the last qualifier in an attempt to find a style that is valid
422 qualifiers.pop_back();
427 styleName = qualifiedStyleName;
432 void StyleManager::ApplyStyle(Toolkit::Builder builder, Toolkit::Control control)
434 std::string styleName = control.GetStyleName();
435 if(GetStyleNameForControl(builder, control, styleName))
437 builder.ApplyStyle(styleName, control);
440 if(mDefaultFontSize >= 0)
442 // Apply the style for logical font size
443 std::stringstream fontSizeQualifier;
444 fontSizeQualifier << styleName << FONT_SIZE_QUALIFIER << mDefaultFontSize;
445 builder.ApplyStyle(fontSizeQualifier.str(), control);
449 const StylePtr StyleManager::GetRecordedStyle(Toolkit::Control control)
453 std::string styleName = control.GetStyleName();
455 if(GetStyleNameForControl(mThemeBuilder, control, styleName))
457 const StylePtr style = GetImpl(mThemeBuilder).GetStyle(styleName);
461 return StylePtr(NULL);
464 Toolkit::Builder StyleManager::FindCachedBuilder(const std::string& key)
466 BuilderMap::iterator builderIt = mBuilderCache.find(key);
467 if(builderIt != mBuilderCache.end())
469 return builderIt->second;
472 return Toolkit::Builder();
475 void StyleManager::CacheBuilder(Toolkit::Builder builder, const std::string& key)
477 mBuilderCache[key] = builder;
480 void StyleManager::StyleMonitorChange(StyleMonitor styleMonitor, StyleChange::Type styleChange)
484 case StyleChange::DEFAULT_FONT_CHANGE:
486 mDefaultFontFamily = styleMonitor.GetDefaultFontFamily();
490 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
492 mDefaultFontSize = styleMonitor.GetDefaultFontSize();
496 case StyleChange::THEME_CHANGE:
498 SetTheme(styleMonitor.GetTheme());
502 EmitStyleChangeSignals(styleChange);
505 void StyleManager::EmitStyleChangeSignals(StyleChange::Type styleChange)
507 Toolkit::StyleManager styleManager = StyleManager::Get();
509 // Update Controls first
510 mControlStyleChangeSignal.Emit(styleManager, styleChange);
512 // Inform application last
513 mStyleChangedSignal.Emit(styleManager, styleChange);
516 } // namespace Internal
518 } // namespace Toolkit