2 * Copyright (c) 2022 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 static constexpr int32_t COUNT_BROKEN_IMAGE_MAX = 3;
50 #if defined(DEBUG_ENABLED)
51 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_STYLE");
66 BaseHandle handle = StyleManager::Get();
70 SingletonService singletonService(SingletonService::Get());
73 Toolkit::StyleManager manager = Toolkit::StyleManager(new Internal::StyleManager());
74 singletonService.Register(typeid(manager), manager);
82 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::StyleManager, Dali::BaseHandle, Create, true)
83 DALI_TYPE_REGISTRATION_END()
87 Toolkit::StyleManager StyleManager::Get()
89 Toolkit::StyleManager manager;
91 SingletonService singletonService(SingletonService::Get());
94 // Check whether the style manager is already created
95 Dali::BaseHandle handle = singletonService.GetSingleton(typeid(Toolkit::StyleManager));
98 // If so, downcast the handle of singleton
99 manager = Toolkit::StyleManager(dynamic_cast<StyleManager*>(handle.GetObjectPtr()));
106 StyleManager::StyleManager()
107 : mDefaultFontSize(-1),
108 mDefaultFontFamily(""),
109 mDefaultThemeFilePath(),
110 mFeedbackStyle(nullptr)
112 // Add theme builder constants
113 const std::string dataReadOnlyDir = AssetManager::GetDaliDataReadOnlyPath();
114 mThemeBuilderConstants[PACKAGE_PATH_KEY] = dataReadOnlyDir + DEFAULT_TOOLKIT_PACKAGE_PATH;
115 mThemeBuilderConstants[APPLICATION_RESOURCE_PATH_KEY] = Application::GetResourcePath();
117 mStyleMonitor = StyleMonitor::Get();
120 mStyleMonitor.StyleChangeSignal().Connect(this, &StyleManager::StyleMonitorChange);
121 mDefaultFontSize = mStyleMonitor.GetDefaultFontSize();
124 // Set the full path for the default style theme.
125 const std::string styleDirPath = AssetManager::GetDaliStylePath();
126 mDefaultThemeFilePath = styleDirPath + DEFAULT_THEME_FILE_NAME;
128 // Sound & haptic style
129 mFeedbackStyle = new FeedbackStyle();
131 // Initialize BrokenImages
132 mBrokenImageUrls.assign(COUNT_BROKEN_IMAGE_MAX, "");
135 StyleManager::~StyleManager()
137 delete mFeedbackStyle;
140 void StyleManager::ApplyTheme(const std::string& themeFile)
145 void StyleManager::ApplyDefaultTheme()
147 SetTheme(mDefaultThemeFilePath);
150 const std::string& StyleManager::GetDefaultFontFamily() const
152 return mDefaultFontFamily;
155 void StyleManager::SetStyleConstant(const std::string& key, const Property::Value& value)
157 mStyleBuilderConstants[key] = value;
160 bool StyleManager::GetStyleConstant(const std::string& key, Property::Value& valueOut)
162 Property::Value* value = mStyleBuilderConstants.Find(key);
172 void StyleManager::ApplyThemeStyle(Toolkit::Control control)
181 ApplyStyle(mThemeBuilder, control);
185 void StyleManager::ApplyThemeStyleAtInit(Toolkit::Control control)
187 ApplyThemeStyle(control);
191 mFeedbackStyle->ObjectCreated(control);
195 void StyleManager::ApplyStyle(Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName)
197 bool builderReady = false;
199 // First look in the cache
200 Toolkit::Builder builder = FindCachedBuilder(jsonFileName);
207 // Merge theme and style constants
208 Property::Map constants(mThemeBuilderConstants);
209 constants.Merge(mStyleBuilderConstants);
212 builder = CreateBuilder(constants);
214 if(LoadJSON(builder, jsonFileName))
216 CacheBuilder(builder, jsonFileName);
221 // Apply the style to the control
224 builder.ApplyStyle(styleName, control);
228 Toolkit::StyleManager::StyleChangedSignalType& StyleManager::StyleChangedSignal()
230 return mStyleChangedSignal;
233 Toolkit::StyleManager::StyleChangedSignalType& StyleManager::ControlStyleChangeSignal()
235 return mControlStyleChangeSignal;
238 Toolkit::DevelStyleManager::BrokenImageChangedSignalType& StyleManager::BrokenImageChangedSignal()
240 return mBrokenImageChangedSignal;
243 void StyleManager::SetTheme(const std::string& themeFile)
245 bool themeLoaded = false;
246 bool loading = false;
248 // If we haven't loaded a theme, or the stored theme file is empty, or
249 // the previously loaded theme is different to the requested theme,
250 // first reset the builder and load the default theme.
251 if(!mThemeBuilder || mThemeFile.empty() || mThemeFile.compare(themeFile) != 0)
254 mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
255 themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath); // Sets themeLoaded to true if theme exists
258 if(themeFile.compare(mDefaultThemeFilePath) != 0)
260 // The theme is different to the default: Merge it
262 themeLoaded |= LoadJSON(mThemeBuilder, themeFile);
267 mThemeFile = themeFile;
271 // We've successfully loaded the theme file
274 mFeedbackStyle->StyleChanged(mThemeFile, StyleChange::THEME_CHANGE);
277 EmitStyleChangeSignals(StyleChange::THEME_CHANGE);
281 // We tried to load a theme, but it failed. Ensure the builder is reset
282 mThemeBuilder.Reset();
288 const Property::Map& StyleManager::GetConfigurations()
290 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On entry, mThemeBuilder: " << (bool(mThemeBuilder) ? "Created" : "Empty") << " mThemeFile: " << mThemeFile);
294 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations() Loading default theme");
296 mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
298 // Load default theme because this is first try to load stylesheet.
299 #if defined(DEBUG_ENABLED)
300 bool themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath);
301 DALI_LOG_STREAM(gLogFilter, Debug::Concise, " themeLoaded" << (themeLoaded ? "success" : "failure"));
303 LoadJSON(mThemeBuilder, mDefaultThemeFilePath);
306 mThemeFile = mDefaultThemeFilePath;
309 #if defined(DEBUG_ENABLED)
310 Property::Map result = mThemeBuilder.GetConfigurations();
311 DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On exit, result Count: " << (result.Count() != 0));
312 DALI_LOG_STREAM(gLogFilter, Debug::Verbose, " result: " << result);
315 return mThemeBuilder.GetConfigurations();
318 void StyleManager::SetBrokenImageUrl(DevelStyleManager::BrokenImageType brokenImageType, const std::string& brokenImageUrl)
320 int brokenType = static_cast<int>(brokenImageType);
321 mBrokenImageUrls[brokenType] = brokenImageUrl;
322 Toolkit::StyleManager styleManager = StyleManager::Get();
323 mBrokenImageChangedSignal.Emit(styleManager);
326 std::string StyleManager::GetBrokenImageUrl(DevelStyleManager::BrokenImageType brokenImageType)
328 int brokenType = static_cast<int>(brokenImageType);
329 return mBrokenImageUrls[brokenType];
332 std::vector<std::string> StyleManager::GetBrokenImageUrlList()
334 // create a list for brokenImage
335 std::vector<std::string> brokenImageUrlList;
336 for(int i = 0; i < COUNT_BROKEN_IMAGE_MAX; i++)
338 if(!mBrokenImageUrls[i].empty())
340 brokenImageUrlList.push_back(mBrokenImageUrls[i]);
343 return brokenImageUrlList;
346 bool StyleManager::LoadFile(const std::string& filename, std::string& stringOut)
348 DALI_ASSERT_DEBUG(0 != filename.length());
350 // as toolkit is platform agnostic, it cannot load files from filesystem
351 // ask style monitor to load the style sheet
354 return mStyleMonitor.LoadThemeFile(filename, stringOut);
360 Toolkit::Builder StyleManager::CreateBuilder(const Property::Map& constants)
362 Toolkit::Builder builder = Toolkit::Builder::New();
363 builder.AddConstants(constants);
368 bool StyleManager::LoadJSON(Toolkit::Builder builder, const std::string& jsonFilePath)
370 std::string fileString;
371 if(LoadFile(jsonFilePath, fileString))
373 builder.LoadFromString(fileString);
378 DALI_LOG_WARNING("Error loading file '%s'\n", jsonFilePath.c_str());
383 static void CollectQualifiers(std::vector<std::string>& qualifiersOut)
385 // Append the relevant qualifier for orientation
386 // int orientation = 0; // Get the orientation from the system
389 Getting orientation from the system, and determine Qualifie LANDSCAPE or PORTRAIT
390 orientation 0, 180 : PORTRAIT_QUALIFIER (default)
391 orientation 90, 270 : LANDSCAPE_QUALIFIER
394 qualifiersOut.push_back(std::string(PORTRAIT_QUALIFIER));
398 * @brief Construct a qualified style name out of qualifiers
400 * A qualifed style name will be in the format: style-qualifier0-qualifier1-qualifierN
402 * @param[in] styleName The root name of the style
403 * @param[in] qualifiers List of qualifier names
404 * @param[out] qualifiedStyleOut The qualified style name
406 static void BuildQualifiedStyleName(
407 const std::string& styleName,
408 const std::vector<std::string>& qualifiers,
409 std::string& qualifiedStyleOut)
411 qualifiedStyleOut.append(styleName);
413 for(std::vector<std::string>::const_iterator it = qualifiers.begin(),
414 itEnd = qualifiers.end();
418 const std::string& str = *it;
420 qualifiedStyleOut.append("-");
421 qualifiedStyleOut.append(str);
425 static bool GetStyleNameForControl(Toolkit::Builder builder, Toolkit::Control control, std::string& styleName)
427 styleName = control.GetStyleName();
429 if(styleName.empty())
431 styleName = control.GetTypeName();
434 // Apply the style after choosing the correct actual style (e.g. landscape or portrait)
435 std::vector<std::string> qualifiers;
436 CollectQualifiers(qualifiers);
439 std::string qualifiedStyleName;
442 qualifiedStyleName.clear();
443 BuildQualifiedStyleName(styleName, qualifiers, qualifiedStyleName);
445 // Break if style found or we have tried the root style name (qualifiers is empty)
446 if(GetImpl(builder).LookupStyleName(qualifiedStyleName))
451 if(qualifiers.size() == 0)
455 // Remove the last qualifier in an attempt to find a style that is valid
456 qualifiers.pop_back();
461 styleName = qualifiedStyleName;
466 void StyleManager::ApplyStyle(Toolkit::Builder builder, Toolkit::Control control)
468 std::string styleName = control.GetStyleName();
469 if(GetStyleNameForControl(builder, control, styleName))
471 builder.ApplyStyle(styleName, control);
474 if(mDefaultFontSize >= 0)
476 // Apply the style for logical font size
477 std::stringstream fontSizeQualifier;
478 fontSizeQualifier << styleName << FONT_SIZE_QUALIFIER << mDefaultFontSize;
479 builder.ApplyStyle(fontSizeQualifier.str(), control);
483 const StylePtr StyleManager::GetRecordedStyle(Toolkit::Control control)
487 std::string styleName = control.GetStyleName();
489 if(GetStyleNameForControl(mThemeBuilder, control, styleName))
491 const StylePtr style = GetImpl(mThemeBuilder).GetStyle(styleName);
495 return StylePtr(NULL);
498 Toolkit::Builder StyleManager::FindCachedBuilder(const std::string& key)
500 BuilderMap::iterator builderIt = mBuilderCache.find(key);
501 if(builderIt != mBuilderCache.end())
503 return builderIt->second;
506 return Toolkit::Builder();
509 void StyleManager::CacheBuilder(Toolkit::Builder builder, const std::string& key)
511 mBuilderCache[key] = builder;
514 void StyleManager::StyleMonitorChange(StyleMonitor styleMonitor, StyleChange::Type styleChange)
518 case StyleChange::DEFAULT_FONT_CHANGE:
520 mDefaultFontFamily = styleMonitor.GetDefaultFontFamily();
524 case StyleChange::DEFAULT_FONT_SIZE_CHANGE:
526 mDefaultFontSize = styleMonitor.GetDefaultFontSize();
530 case StyleChange::THEME_CHANGE:
532 SetTheme(styleMonitor.GetTheme());
536 EmitStyleChangeSignals(styleChange);
539 void StyleManager::EmitStyleChangeSignals(StyleChange::Type styleChange)
541 Toolkit::StyleManager styleManager = StyleManager::Get();
543 // Update Controls first
544 mControlStyleChangeSignal.Emit(styleManager, styleChange);
546 // Inform application last
547 mStyleChangedSignal.Emit(styleManager, styleChange);
550 } // namespace Internal
552 } // namespace Toolkit