/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "style-manager-impl.h"
// EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/singleton-service.h>
-#include <dali/public-api/object/type-registry.h>
-#include <dali/devel-api/object/type-registry-helper.h>
+#include <dali/devel-api/common/singleton-service.h>
#include <dali/integration-api/debug.h>
+#include <dali/public-api/adaptor-framework/application.h>
+#include <dali/public-api/object/type-registry-helper.h>
+#include <dali/public-api/object/type-registry.h>
// INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/control.h>
-#include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali-toolkit/devel-api/styling/style-manager.h>
+#include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
+#include <dali-toolkit/internal/builder/builder-impl.h>
#include <dali-toolkit/internal/feedback/feedback-style.h>
+#include <dali-toolkit/public-api/controls/control-impl.h>
+#include <dali-toolkit/public-api/controls/control.h>
+#include <dali-toolkit/public-api/styling/style-manager.h>
namespace
{
-
-const char* LANDSCAPE_QUALIFIER = "landscape";
+//const char* LANDSCAPE_QUALIFIER = "landscape";
const char* PORTRAIT_QUALIFIER = "portrait";
-const char* FONT_SIZE_QUALIFIER = "font-size-";
+const char* FONT_SIZE_QUALIFIER = "fontsize";
+
+const char* DEFAULT_THEME_FILE_NAME = "dali-toolkit-default-theme.json";
+
+const char* PACKAGE_PATH_KEY = "PACKAGE_PATH";
+const char* APPLICATION_RESOURCE_PATH_KEY = "APPLICATION_RESOURCE_PATH";
-const char* DEFAULT_THEME = DALI_STYLE_DIR "dali-toolkit-default-theme.json";
+const char* DEFAULT_TOOLKIT_PACKAGE_PATH = "/toolkit/";
-const char* PACKAGE_PATH_KEY = "PACKAGE_PATH";
-const char* DEFAULT_PACKAGE_PATH = DALI_DATA_READ_ONLY_DIR "/toolkit/";
+#if defined(DEBUG_ENABLED)
+Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_STYLE");
+#endif
} // namespace
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
namespace
{
-
BaseHandle Create()
{
BaseHandle handle = StyleManager::Get();
- if ( !handle )
+ if(!handle)
{
- SingletonService singletonService( SingletonService::Get() );
- if ( singletonService )
+ SingletonService singletonService(SingletonService::Get());
+ if(singletonService)
{
- Toolkit::StyleManager manager = Toolkit::StyleManager( new Internal::StyleManager() );
- singletonService.Register( typeid( manager ), manager );
+ Toolkit::StyleManager manager = Toolkit::StyleManager(new Internal::StyleManager());
+ singletonService.Register(typeid(manager), manager);
handle = manager;
}
}
return handle;
}
-DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::StyleManager, Dali::BaseHandle, Create, true )
+DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::StyleManager, Dali::BaseHandle, Create, true)
DALI_TYPE_REGISTRATION_END()
} // namespace
{
Toolkit::StyleManager manager;
- SingletonService singletonService( SingletonService::Get() );
- if ( singletonService )
+ SingletonService singletonService(SingletonService::Get());
+ if(singletonService)
{
// Check whether the style manager is already created
- Dali::BaseHandle handle = singletonService.GetSingleton( typeid( Toolkit::StyleManager ) );
- if( handle )
+ Dali::BaseHandle handle = singletonService.GetSingleton(typeid(Toolkit::StyleManager));
+ if(handle)
{
// If so, downcast the handle of singleton
- manager = Toolkit::StyleManager( dynamic_cast< StyleManager* >( handle.GetObjectPtr() ) );
+ manager = Toolkit::StyleManager(dynamic_cast<StyleManager*>(handle.GetObjectPtr()));
}
}
}
StyleManager::StyleManager()
-: mOrientationDegrees( 0 ), // Portrait
- mDefaultFontSize( -1 ),
+: mDefaultFontSize(-1),
mDefaultFontFamily(""),
- mThemeFile( DEFAULT_THEME ),
- mFeedbackStyle( NULL )
+ mDefaultThemeFilePath(),
+ mFeedbackStyle(nullptr)
{
// Add theme builder constants
- mThemeBuilderConstants[ PACKAGE_PATH_KEY ] = DEFAULT_PACKAGE_PATH;
+ const std::string dataReadOnlyDir = AssetManager::GetDaliDataReadOnlyPath();
+ mThemeBuilderConstants[PACKAGE_PATH_KEY] = dataReadOnlyDir + DEFAULT_TOOLKIT_PACKAGE_PATH;
+ mThemeBuilderConstants[APPLICATION_RESOURCE_PATH_KEY] = Application::GetResourcePath();
mStyleMonitor = StyleMonitor::Get();
- if( mStyleMonitor )
+ if(mStyleMonitor)
{
- mStyleMonitor.StyleChangeSignal().Connect( this, &StyleManager::StyleMonitorChange );
-
+ mStyleMonitor.StyleChangeSignal().Connect(this, &StyleManager::StyleMonitorChange);
mDefaultFontSize = mStyleMonitor.GetDefaultFontSize();
}
+ // Set the full path for the default style theme.
+ const std::string styleDirPath = AssetManager::GetDaliStylePath();
+ mDefaultThemeFilePath = styleDirPath + DEFAULT_THEME_FILE_NAME;
+
// Sound & haptic style
mFeedbackStyle = new FeedbackStyle();
-
}
StyleManager::~StyleManager()
delete mFeedbackStyle;
}
-void StyleManager::SetOrientationValue( int orientation )
+void StyleManager::ApplyTheme(const std::string& themeFile)
{
- if( orientation != mOrientationDegrees )
- {
- mOrientationDegrees = orientation;
- // TODO: if orientation changed, apply the new style to all controls
- // dont want to really do the whole load from file again if the bundle contains both portrait & landscape
- SetTheme();
- }
+ SetTheme(themeFile);
}
-int StyleManager::GetOrientationValue()
+void StyleManager::ApplyDefaultTheme()
{
- return mOrientationDegrees;
+ SetTheme(mDefaultThemeFilePath);
}
-void StyleManager::SetOrientation( Orientation orientation )
-{
- if( mOrientation )
- {
- mOrientation.ChangedSignal().Disconnect( this, &StyleManager::OnOrientationChanged );
- }
-
- OnOrientationChanged( orientation );
-
- if( mOrientation )
- {
- mOrientation.ChangedSignal().Connect( this, &StyleManager::OnOrientationChanged );
- }
-}
-
-std::string StyleManager::GetDefaultFontFamily() const
+const std::string& StyleManager::GetDefaultFontFamily() const
{
return mDefaultFontFamily;
}
-Orientation StyleManager::GetOrientation()
+void StyleManager::SetStyleConstant(const std::string& key, const Property::Value& value)
{
- return mOrientation;
+ mStyleBuilderConstants[key] = value;
}
-void StyleManager::SetStyleConstant( const std::string& key, const Property::Value& value )
+bool StyleManager::GetStyleConstant(const std::string& key, Property::Value& valueOut)
{
- mStyleBuilderConstants[ key ] = value;
-}
-
-bool StyleManager::GetStyleConstant( const std::string& key, Property::Value& valueOut )
-{
- Property::Value* value = mStyleBuilderConstants.Find( key );
- if( value )
+ Property::Value* value = mStyleBuilderConstants.Find(key);
+ if(value)
{
valueOut = *value;
return true;
return false;
}
-void StyleManager::OnOrientationChanged( Orientation orientation )
-{
- mOrientation = orientation;
- // TODO: if orientation changed, apply the new style to all controls
- // dont want to really do the whole load from file again if the bundle contains both portrait & landscape
- SetTheme();
-}
-
-Toolkit::Builder StyleManager::CreateBuilder( const Property::Map& constants )
-{
- Toolkit::Builder builder = Toolkit::Builder::New();
- builder.AddConstants( constants );
-
- return builder;
-}
-
-bool StyleManager::LoadJSON( Toolkit::Builder builder, const std::string& jsonFilePath )
-{
- std::string fileString;
- if( LoadFile( jsonFilePath, fileString ) )
- {
- builder.LoadFromString( fileString );
- return true;
- }
- else
- {
- DALI_LOG_WARNING("Error loading file '%s'\n", jsonFilePath.c_str());
- return false;
- }
-}
-
-void StyleManager::CollectQualifiers( StringList& qualifiersOut )
+void StyleManager::ApplyThemeStyle(Toolkit::Control control)
{
- // Append the relevant qualifier for orientation
- int orientation = mOrientationDegrees;
-
- if( mOrientation )
+ if(!mThemeBuilder)
{
- orientation = mOrientation.GetDegrees();
+ ApplyDefaultTheme();
}
- switch( orientation )
+ if(mThemeBuilder)
{
- case 90:
- case 270:
- {
- qualifiersOut.push_back( std::string( LANDSCAPE_QUALIFIER ) );
- break;
- }
- case 180:
- case 0: // fall through
- default:
- {
- qualifiersOut.push_back( std::string( PORTRAIT_QUALIFIER ) );
- break;
- }
+ ApplyStyle(mThemeBuilder, control);
}
}
-void StyleManager::BuildQualifiedStyleName( const std::string& styleName, const StringList& qualifiers, std::string& qualifiedStyleOut )
+void StyleManager::ApplyThemeStyleAtInit(Toolkit::Control control)
{
- qualifiedStyleOut.append( styleName );
+ ApplyThemeStyle(control);
- for( StringList::const_iterator it = qualifiers.begin(), itEnd = qualifiers.end(); it != itEnd; ++it )
+ if(mFeedbackStyle)
{
- const std::string& str = *it;
-
- qualifiedStyleOut.append( "-" );
- qualifiedStyleOut.append( str );
+ mFeedbackStyle->ObjectCreated(control);
}
}
-void StyleManager::ApplyStyle( Toolkit::Builder builder, Toolkit::Control control )
+void StyleManager::ApplyStyle(Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName)
{
- std::string styleName = control.GetStyleName();
+ bool builderReady = false;
- if( styleName.empty() )
+ // First look in the cache
+ Toolkit::Builder builder = FindCachedBuilder(jsonFileName);
+ if(builder)
{
- // Convert control name to lower case
- styleName = control.GetTypeName();
- std::transform( styleName.begin(), styleName.end(), styleName.begin(), ::tolower );
+ builderReady = true;
}
-
- // Apply the style after choosing the correct actual style (e.g. landscape or portrait)
- StringList qualifiers;
- CollectQualifiers( qualifiers );
-
- while( true )
+ else
{
- std::string qualifiedStyleName;
- BuildQualifiedStyleName( styleName, qualifiers, qualifiedStyleName );
+ // Merge theme and style constants
+ Property::Map constants(mThemeBuilderConstants);
+ constants.Merge(mStyleBuilderConstants);
- // Break if style found or we have tried the root style name (qualifiers is empty)
- if( builder.ApplyStyle( qualifiedStyleName, control ) || qualifiers.size() == 0 )
+ // Create it
+ builder = CreateBuilder(constants);
+
+ if(LoadJSON(builder, jsonFileName))
{
- break;
+ CacheBuilder(builder, jsonFileName);
+ builderReady = true;
}
-
- // Remove the last qualifier in an attempt to find a style that is valid
- qualifiers.pop_back();
}
- if( mDefaultFontSize >= 0 )
+ // Apply the style to the control
+ if(builderReady)
{
- // Apply the style for logical font size
- std::stringstream fontSizeQualifier;
- fontSizeQualifier << styleName << "-" << FONT_SIZE_QUALIFIER << mDefaultFontSize;
- builder.ApplyStyle( fontSizeQualifier.str(), control );
+ builder.ApplyStyle(styleName, control);
}
}
-void StyleManager::ApplyThemeStyle( Toolkit::Control control )
+Toolkit::StyleManager::StyleChangedSignalType& StyleManager::StyleChangedSignal()
{
- if( !mThemeBuilder )
+ return mStyleChangedSignal;
+}
+
+Toolkit::StyleManager::StyleChangedSignalType& StyleManager::ControlStyleChangeSignal()
+{
+ return mControlStyleChangeSignal;
+}
+
+void StyleManager::SetTheme(const std::string& themeFile)
+{
+ bool themeLoaded = false;
+ bool loading = false;
+
+ // If we haven't loaded a theme, or the stored theme file is empty, or
+ // the previously loaded theme is different to the requested theme,
+ // first reset the builder and load the default theme.
+ if(!mThemeBuilder || mThemeFile.empty() || mThemeFile.compare(themeFile) != 0)
{
- RequestDefaultTheme();
+ loading = true;
+ mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
+ themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath); // Sets themeLoaded to true if theme exists
}
- if( mThemeBuilder )
+ if(themeFile.compare(mDefaultThemeFilePath) != 0)
{
- ApplyStyle( mThemeBuilder, control );
+ // The theme is different to the default: Merge it
+ loading = true;
+ themeLoaded |= LoadJSON(mThemeBuilder, themeFile);
}
-}
-
-void StyleManager::ApplyThemeStyleAtInit( Toolkit::Control control )
-{
- ApplyThemeStyle( control );
- if(mFeedbackStyle)
+ if(loading)
{
- mFeedbackStyle->ObjectCreated( control );
+ mThemeFile = themeFile;
+
+ if(themeLoaded)
+ {
+ // We've successfully loaded the theme file
+ if(mFeedbackStyle)
+ {
+ mFeedbackStyle->StyleChanged(mThemeFile, StyleChange::THEME_CHANGE);
+ }
+
+ EmitStyleChangeSignals(StyleChange::THEME_CHANGE);
+ }
+ else
+ {
+ // We tried to load a theme, but it failed. Ensure the builder is reset
+ mThemeBuilder.Reset();
+ mThemeFile.clear();
+ }
}
}
-void StyleManager::ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName )
+const Property::Map StyleManager::GetConfigurations()
{
- bool builderReady = false;
+ DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On entry, mThemeBuilder: " << (bool(mThemeBuilder) ? "Created" : "Empty") << " mThemeFile: " << mThemeFile);
- // First look in the cache
- Toolkit::Builder builder = FindCachedBuilder( jsonFileName );
- if( builder )
+ Property::Map result;
+ if(mThemeBuilder)
{
- builderReady = true;
+ result = mThemeBuilder.GetConfigurations();
}
else
{
- // Merge theme and style constants
- Property::Map constants( mThemeBuilderConstants );
- constants.Merge( mStyleBuilderConstants );
+ DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations() Loading default theme");
- // Create it
- builder = CreateBuilder( constants );
+ bool themeLoaded = false;
+
+ mThemeBuilder = CreateBuilder(mThemeBuilderConstants);
- if( LoadJSON( builder, jsonFileName ) )
+ // Load default theme because this is first try to load stylesheet.
+ themeLoaded = LoadJSON(mThemeBuilder, mDefaultThemeFilePath);
+ mThemeFile = mDefaultThemeFilePath;
+
+ if(themeLoaded)
{
- CacheBuilder( builder, jsonFileName );
- builderReady = true;
+ result = mThemeBuilder.GetConfigurations();
}
+ DALI_LOG_STREAM(gLogFilter, Debug::Concise, " themeLoaded" << (themeLoaded ? "success" : "failure"));
}
- // Apply the style to the control
- if( builderReady )
- {
- builder.ApplyStyle( styleName, control );
- }
+ DALI_LOG_STREAM(gLogFilter, Debug::Concise, "GetConfigurations()\n On exit, result Count: " << (result.Count() != 0));
+ DALI_LOG_STREAM(gLogFilter, Debug::Verbose, " result: " << result);
+
+ return result;
}
-bool StyleManager::LoadFile( const std::string& filename, std::string& stringOut )
+bool StyleManager::LoadFile(const std::string& filename, std::string& stringOut)
{
- DALI_ASSERT_DEBUG( 0 != filename.length());
+ DALI_ASSERT_DEBUG(0 != filename.length());
// as toolkit is platform agnostic, it cannot load files from filesystem
// ask style monitor to load the style sheet
- if( mStyleMonitor )
+ if(mStyleMonitor)
{
- return mStyleMonitor.LoadThemeFile( filename, stringOut );
+ return mStyleMonitor.LoadThemeFile(filename, stringOut);
}
return false;
}
-Toolkit::StyleManager::StyleChangeSignalType& StyleManager::StyleChangeSignal()
+Toolkit::Builder StyleManager::CreateBuilder(const Property::Map& constants)
{
- return mStyleChangeSignal;
+ Toolkit::Builder builder = Toolkit::Builder::New();
+ builder.AddConstants(constants);
+
+ return builder;
}
-void StyleManager::RequestThemeChange( const std::string& themeFile )
+bool StyleManager::LoadJSON(Toolkit::Builder builder, const std::string& jsonFilePath)
{
- mThemeFile = themeFile;
+ std::string fileString;
+ if(LoadFile(jsonFilePath, fileString))
+ {
+ builder.LoadFromString(fileString);
+ return true;
+ }
+ else
+ {
+ DALI_LOG_WARNING("Error loading file '%s'\n", jsonFilePath.c_str());
+ return false;
+ }
+}
- // need to do style change synchronously as app might create a UI control on the next line
- SetTheme();
+static void CollectQualifiers(std::vector<std::string>& qualifiersOut)
+{
+ // Append the relevant qualifier for orientation
+ // int orientation = 0; // Get the orientation from the system
+ /*
+ //// To Do /////
+ Getting orientation from the system, and determine Qualifie LANDSCAPE or PORTRAIT
+ orientation 0, 180 : PORTRAIT_QUALIFIER (default)
+ orientation 90, 270 : LANDSCAPE_QUALIFIER
+ */
+
+ qualifiersOut.push_back(std::string(PORTRAIT_QUALIFIER));
}
-void StyleManager::RequestDefaultTheme()
+/**
+ * @brief Construct a qualified style name out of qualifiers
+ *
+ * A qualifed style name will be in the format: style-qualifier0-qualifier1-qualifierN
+ *
+ * @param[in] styleName The root name of the style
+ * @param[in] qualifiers List of qualifier names
+ * @param[out] qualifiedStyleOut The qualified style name
+ */
+static void BuildQualifiedStyleName(
+ const std::string& styleName,
+ const std::vector<std::string>& qualifiers,
+ std::string& qualifiedStyleOut)
{
- RequestThemeChange( DEFAULT_THEME );
+ qualifiedStyleOut.append(styleName);
+
+ for(std::vector<std::string>::const_iterator it = qualifiers.begin(),
+ itEnd = qualifiers.end();
+ it != itEnd;
+ ++it)
+ {
+ const std::string& str = *it;
+
+ qualifiedStyleOut.append("-");
+ qualifiedStyleOut.append(str);
+ }
}
-void StyleManager::SetTheme()
+static bool GetStyleNameForControl(Toolkit::Builder builder, Toolkit::Control control, std::string& styleName)
{
- mThemeBuilder = CreateBuilder( mThemeBuilderConstants );
+ styleName = control.GetStyleName();
- if( LoadJSON( mThemeBuilder, mThemeFile ) )
+ if(styleName.empty())
{
- if(mFeedbackStyle)
+ styleName = control.GetTypeName();
+ }
+
+ // Apply the style after choosing the correct actual style (e.g. landscape or portrait)
+ std::vector<std::string> qualifiers;
+ CollectQualifiers(qualifiers);
+
+ bool found = 0;
+ std::string qualifiedStyleName;
+ do
+ {
+ qualifiedStyleName.clear();
+ BuildQualifiedStyleName(styleName, qualifiers, qualifiedStyleName);
+
+ // Break if style found or we have tried the root style name (qualifiers is empty)
+ if(GetImpl(builder).LookupStyleName(qualifiedStyleName))
+ {
+ found = true;
+ break;
+ }
+ if(qualifiers.size() == 0)
{
- mFeedbackStyle->StyleChanged( mThemeFile, StyleChange::THEME_CHANGE );
+ break;
}
+ // Remove the last qualifier in an attempt to find a style that is valid
+ qualifiers.pop_back();
+ } while(!found);
- mStyleChangeSignal.Emit( Toolkit::StyleManager::Get(), StyleChange::THEME_CHANGE );
+ if(found)
+ {
+ styleName = qualifiedStyleName;
}
- else
+ return found;
+}
+
+void StyleManager::ApplyStyle(Toolkit::Builder builder, Toolkit::Control control)
+{
+ std::string styleName = control.GetStyleName();
+ if(GetStyleNameForControl(builder, control, styleName))
{
- mThemeBuilder.Reset();
+ builder.ApplyStyle(styleName, control);
}
+
+ if(mDefaultFontSize >= 0)
+ {
+ // Apply the style for logical font size
+ std::stringstream fontSizeQualifier;
+ fontSizeQualifier << styleName << FONT_SIZE_QUALIFIER << mDefaultFontSize;
+ builder.ApplyStyle(fontSizeQualifier.str(), control);
+ }
+}
+
+const StylePtr StyleManager::GetRecordedStyle(Toolkit::Control control)
+{
+ if(mThemeBuilder)
+ {
+ std::string styleName = control.GetStyleName();
+
+ if(GetStyleNameForControl(mThemeBuilder, control, styleName))
+ {
+ const StylePtr style = GetImpl(mThemeBuilder).GetStyle(styleName);
+ return style;
+ }
+ }
+ return StylePtr(NULL);
}
-Toolkit::Builder StyleManager::FindCachedBuilder( const std::string& key )
+Toolkit::Builder StyleManager::FindCachedBuilder(const std::string& key)
{
- BuilderMap::iterator builderIt = mBuilderCache.find( key );
- if( builderIt != mBuilderCache.end() )
+ BuilderMap::iterator builderIt = mBuilderCache.find(key);
+ if(builderIt != mBuilderCache.end())
{
return builderIt->second;
}
return Toolkit::Builder();
}
-void StyleManager::CacheBuilder( Toolkit::Builder builder, const std::string& key )
+void StyleManager::CacheBuilder(Toolkit::Builder builder, const std::string& key)
{
- mBuilderCache[ key ] = builder;
+ mBuilderCache[key] = builder;
}
-void StyleManager::StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange )
+void StyleManager::StyleMonitorChange(StyleMonitor styleMonitor, StyleChange::Type styleChange)
{
- switch ( styleChange )
+ switch(styleChange)
{
case StyleChange::DEFAULT_FONT_CHANGE:
{
case StyleChange::THEME_CHANGE:
{
- const std::string& newTheme = styleMonitor.GetTheme();
- if( ! newTheme.empty() )
- {
- mThemeFile = newTheme;
- }
- else
- {
- mThemeFile = DEFAULT_THEME;
- }
-
- SetTheme();
+ SetTheme(styleMonitor.GetTheme());
break;
}
}
+ EmitStyleChangeSignals(styleChange);
+}
+
+void StyleManager::EmitStyleChangeSignals(StyleChange::Type styleChange)
+{
+ Toolkit::StyleManager styleManager = StyleManager::Get();
+
+ // Update Controls first
+ mControlStyleChangeSignal.Emit(styleManager, styleChange);
- mStyleChangeSignal.Emit( Toolkit::StyleManager::Get(), styleChange );
+ // Inform application last
+ mStyleChangedSignal.Emit(styleManager, styleChange);
}
} // namespace Internal