/*
- * Copyright (c) 2015 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.
// CLASS HEADER
#include <dali-toolkit/internal/text/multi-language-support-impl.h>
-// INTERNAL INCLUDES
-#include <dali/public-api/adaptor-framework/singleton-service.h>
-#include <dali/public-api/text-abstraction/font-client.h>
-#include <dali-toolkit/public-api/text/logical-model.h>
-#include <dali-toolkit/public-api/text/font-run.h>
-#include <dali-toolkit/public-api/text/script.h>
-#include <dali-toolkit/public-api/text/script-run.h>
+// EXTERNAL INCLUDES
+#include <dali/devel-api/common/singleton-service.h>
+#include <dali/devel-api/text-abstraction/font-client.h>
#include <dali/integration-api/debug.h>
-// EXTERNAL INCLUDES
-#include <memory.h>
+// INTERNAL INCLUDES
+#include <dali-toolkit/internal/text/multi-language-helper-functions.h>
namespace Dali
{
-
namespace Toolkit
{
+namespace
+{
+#if defined(DEBUG_ENABLED)
+Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_MULTI_LANGUAGE_SUPPORT");
+#endif
+
+const Dali::Toolkit::Text::Character UTF32_A = 0x0041;
+} // namespace
namespace Text
{
-
namespace Internal
{
-
-/**
- * @brief Retrieves the font Id from the font run for a given character's @p index.
- *
- * If the character's index exceeds the current font run it increases the iterator to get the next one.
- *
- * @param[in] index The character's index.
- * @param[in,out] fontRunIt Iterator to the current font run.
- * @param[in] fontRunEndIt Iterator to one after the last font run.
- *
- * @return The font id.
- */
-FontId GetFontId( Length index,
- Vector<FontRun>::ConstIterator& fontRunIt,
- const Vector<FontRun>::ConstIterator& fontRunEndIt )
+bool ValidateFontsPerScript::IsValidFont(FontId fontId) const
{
- FontId fontId = 0u;
-
- if( fontRunIt != fontRunEndIt )
+ for(Vector<FontId>::ConstIterator it = mValidFonts.Begin(),
+ endIt = mValidFonts.End();
+ it != endIt;
+ ++it)
{
- const FontRun& fontRun = *fontRunIt;
-
- if( ( index >= fontRun.characterRun.characterIndex ) &&
- ( index < fontRun.characterRun.characterIndex + fontRun.characterRun.numberOfCharacters ) )
+ if(fontId == *it)
{
- fontId = fontRun.fontId;
- }
-
- if( index == fontRun.characterRun.characterIndex + fontRun.characterRun.numberOfCharacters )
- {
- // All the characters of the current run have been traversed. Get the next one for the next iteration.
- ++fontRunIt;
+ return true;
}
}
- return fontId;
+ return false;
}
-/**
- * @brief Retrieves the script Id from the script run for a given character's @p index.
- *
- * If the character's index exceeds the current script run it increases the iterator to get the next one.
- *
- * @param[in] index The character's index.
- * @param[in,out] scriptRunIt Iterator to the current font run.
- * @param[in] scriptRunEndIt Iterator to one after the last script run.
- *
- * @return The script.
- */
-Script GetScript( Length index,
- Vector<ScriptRun>::ConstIterator& scriptRunIt,
- const Vector<ScriptRun>::ConstIterator& scriptRunEndIt )
+FontId DefaultFonts::FindFont(TextAbstraction::FontClient& fontClient,
+ const TextAbstraction::FontDescription& description,
+ PointSize26Dot6 size) const
{
- Script script = TextAbstraction::UNKNOWN;
-
- if( scriptRunIt != scriptRunEndIt )
+ for(std::vector<CacheItem>::const_iterator it = mFonts.begin(),
+ endIt = mFonts.end();
+ it != endIt;
+ ++it)
{
- const ScriptRun& scriptRun = *scriptRunIt;
+ const CacheItem& item = *it;
- if( ( index >= scriptRun.characterRun.characterIndex ) &&
- ( index < scriptRun.characterRun.characterIndex + scriptRun.characterRun.numberOfCharacters ) )
+ if(((TextAbstraction::FontWeight::NONE == description.weight) || (description.weight == item.description.weight)) &&
+ ((TextAbstraction::FontWidth::NONE == description.width) || (description.width == item.description.width)) &&
+ ((TextAbstraction::FontSlant::NONE == description.slant) || (description.slant == item.description.slant)) &&
+ (size == fontClient.GetPointSize(item.fontId)) &&
+ (description.family.empty() || (description.family == item.description.family)))
{
- script = scriptRun.script;
- }
-
- if( index == scriptRun.characterRun.characterIndex + scriptRun.characterRun.numberOfCharacters )
- {
- // All the characters of the current run have been traversed. Get the next one for the next iteration.
- ++scriptRunIt;
+ return item.fontId;
}
}
- return script;
+ return 0u;
}
-bool ValidateFontsPerScript::FindValidFont( FontId fontId ) const
+void DefaultFonts::Cache(const TextAbstraction::FontDescription& description, FontId fontId)
{
- for( Vector<FontId>::ConstIterator it = mValidFonts.Begin(),
- endIt = mValidFonts.End();
- it != endIt;
- ++it )
- {
- if( fontId == *it )
- {
- return true;
- }
- }
-
- return false;
+ CacheItem item;
+ item.description = description;
+ item.fontId = fontId;
+ mFonts.push_back(item);
}
MultilanguageSupport::MultilanguageSupport()
{
// Initializes the default font cache to zero (invalid font).
// Reserves space to cache the default fonts and access them with the script as an index.
- mDefaultFontPerScriptCache.Resize( TextAbstraction::UNKNOWN, 0u );
+ mDefaultFontPerScriptCache.Resize(TextAbstraction::UNKNOWN + 1, NULL);
// Initializes the valid fonts cache to NULL (no valid fonts).
// Reserves space to cache the valid fonts and access them with the script as an index.
- mValidFontsPerScriptCache.Resize( TextAbstraction::UNKNOWN, NULL );
+ mValidFontsPerScriptCache.Resize(TextAbstraction::UNKNOWN + 1, NULL);
}
MultilanguageSupport::~MultilanguageSupport()
{
- // Destroy the valid fonts per script cache.
+ // Destroy the default font per script cache.
+ for(Vector<DefaultFonts*>::Iterator it = mDefaultFontPerScriptCache.Begin(),
+ endIt = mDefaultFontPerScriptCache.End();
+ it != endIt;
+ ++it)
+ {
+ delete *it;
+ }
- for( Vector<ValidateFontsPerScript*>::Iterator it = mValidFontsPerScriptCache.Begin(),
- endIt = mValidFontsPerScriptCache.End();
- it != endIt;
- ++it )
+ // Destroy the valid fonts per script cache.
+ for(Vector<ValidateFontsPerScript*>::Iterator it = mValidFontsPerScriptCache.Begin(),
+ endIt = mValidFontsPerScriptCache.End();
+ it != endIt;
+ ++it)
{
delete *it;
}
{
Text::MultilanguageSupport multilanguageSupportHandle;
- SingletonService service( SingletonService::Get() );
- if( service )
+ SingletonService service(SingletonService::Get());
+ if(service)
{
// Check whether the singleton is already created
- Dali::BaseHandle handle = service.GetSingleton( typeid( Text::MultilanguageSupport ) );
- if( handle )
+ Dali::BaseHandle handle = service.GetSingleton(typeid(Text::MultilanguageSupport));
+ if(handle)
{
// If so, downcast the handle
- MultilanguageSupport* impl = dynamic_cast< Internal::MultilanguageSupport* >( handle.GetObjectPtr() );
- multilanguageSupportHandle = Text::MultilanguageSupport( impl );
+ MultilanguageSupport* impl = dynamic_cast<Internal::MultilanguageSupport*>(handle.GetObjectPtr());
+ multilanguageSupportHandle = Text::MultilanguageSupport(impl);
}
else // create and register the object
{
- multilanguageSupportHandle = Text::MultilanguageSupport( new MultilanguageSupport );
- service.Register( typeid( multilanguageSupportHandle ), multilanguageSupportHandle );
+ multilanguageSupportHandle = Text::MultilanguageSupport(new MultilanguageSupport);
+ service.Register(typeid(multilanguageSupportHandle), multilanguageSupportHandle);
}
}
return multilanguageSupportHandle;
}
-void MultilanguageSupport::SetScripts( const Vector<Character>& text,
- Vector<ScriptRun>& scripts )
+void MultilanguageSupport::SetScripts(const Vector<Character>& text,
+ CharacterIndex startIndex,
+ Length numberOfCharacters,
+ Vector<ScriptRun>& scripts)
{
- const Length numberOfCharacters = text.Count();
-
- if( 0u == numberOfCharacters )
+ if(0u == numberOfCharacters)
{
// Nothing to do if there are no characters.
return;
}
- // Traverse all characters and set the scripts.
+ // Find the first index where to insert the script.
+ ScriptRunIndex scriptIndex = 0u;
+ if(0u != startIndex)
+ {
+ for(Vector<ScriptRun>::ConstIterator it = scripts.Begin(),
+ endIt = scripts.End();
+ it != endIt;
+ ++it, ++scriptIndex)
+ {
+ const ScriptRun& run = *it;
+ if(startIndex < run.characterRun.characterIndex + run.characterRun.numberOfCharacters)
+ {
+ // Run found.
+ break;
+ }
+ }
+ }
// Stores the current script run.
ScriptRun currentScriptRun;
- currentScriptRun.characterRun.characterIndex = 0u;
+ currentScriptRun.characterRun.characterIndex = startIndex;
currentScriptRun.characterRun.numberOfCharacters = 0u;
- currentScriptRun.script = TextAbstraction::UNKNOWN;
+ currentScriptRun.script = TextAbstraction::UNKNOWN;
// Reserve some space to reduce the number of reallocations.
- scripts.Reserve( numberOfCharacters << 2u );
+ scripts.Reserve(text.Count() << 2u);
+
+ // Whether the first valid script needs to be set.
+ bool isFirstScriptToBeSet = true;
+
+ // Whether the first valid script is a right to left script.
+ bool isParagraphRTL = false;
- for( Length index = 0u; index < numberOfCharacters; ++index )
+ // Count the number of characters which are valid for all scripts. i.e. white spaces or '\n'.
+ Length numberOfAllScriptCharacters = 0u;
+
+ // Pointers to the text buffer.
+ const Character* const textBuffer = text.Begin();
+
+ // Initialize whether is right to left direction
+ currentScriptRun.isRightToLeft = false;
+
+ // Traverse all characters and set the scripts.
+ const Length lastCharacter = startIndex + numberOfCharacters;
+ for(Length index = startIndex; index < lastCharacter; ++index)
{
- const Character character = *( text.Begin() + index );
+ Character character = *(textBuffer + index);
+
+ // Get the script of the character.
+ Script script = TextAbstraction::GetCharacterScript(character);
+
+ // Some characters (like white spaces) are valid for many scripts. The rules to set a script
+ // for them are:
+ // - If they are at the begining of a paragraph they get the script of the first character with
+ // a defined script. If they are at the end, they get the script of the last one.
+ // - If they are between two scripts with the same direction, they get the script of the previous
+ // character with a defined script. If the two scripts have different directions, they get the
+ // script of the first character of the paragraph with a defined script.
+
+ // Skip those characters valid for many scripts like white spaces or '\n'.
+ bool endOfText = index == lastCharacter;
+ while(!endOfText &&
+ (TextAbstraction::COMMON == script))
+ {
+ // Check if whether is right to left markup and Keeps true if the previous value was true.
+ currentScriptRun.isRightToLeft = currentScriptRun.isRightToLeft || TextAbstraction::IsRightToLeftMark(character);
+
+ // ZWJ, ZWNJ between emojis should be treated as EMOJI.
+ if(TextAbstraction::EMOJI == currentScriptRun.script && !(TextAbstraction::IsZeroWidthJoiner(character) || TextAbstraction::IsZeroWidthNonJoiner(character)))
+ {
+ // Emojis doesn't mix well with characters common to all scripts. Insert the emoji run.
+ scripts.Insert(scripts.Begin() + scriptIndex, currentScriptRun);
+ ++scriptIndex;
+
+ // Initialize the new one.
+ currentScriptRun.characterRun.characterIndex = currentScriptRun.characterRun.characterIndex + currentScriptRun.characterRun.numberOfCharacters;
+ currentScriptRun.characterRun.numberOfCharacters = 0u;
+ currentScriptRun.script = TextAbstraction::UNKNOWN;
+ numberOfAllScriptCharacters = 0u;
+ }
+
+ // Count all these characters to be added into a script.
+ ++numberOfAllScriptCharacters;
+
+ if(TextAbstraction::IsNewParagraph(character))
+ {
+ // The character is a new paragraph.
+ // To know when there is a new paragraph is needed because if there is a white space
+ // between two scripts with different directions, it is added to the script with
+ // the same direction than the first script of the paragraph.
+ isFirstScriptToBeSet = true;
+
+ // Characters common to all scripts at the end of the paragraph are added to the last script.
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+
+ // Store the script run.
+ scripts.Insert(scripts.Begin() + scriptIndex, currentScriptRun);
+ ++scriptIndex;
+
+ // Initialize the new one.
+ currentScriptRun.characterRun.characterIndex = currentScriptRun.characterRun.characterIndex + currentScriptRun.characterRun.numberOfCharacters;
+ currentScriptRun.characterRun.numberOfCharacters = 0u;
+ currentScriptRun.script = TextAbstraction::UNKNOWN;
+ numberOfAllScriptCharacters = 0u;
+ // Initialize whether is right to left direction
+ currentScriptRun.isRightToLeft = false;
+ }
- Script script = GetCharacterScript( character );
+ // Get the next character.
+ ++index;
+ endOfText = index == lastCharacter;
+ if(!endOfText)
+ {
+ character = *(textBuffer + index);
+ script = TextAbstraction::GetCharacterScript(character);
+ }
+ } // end while( !endOfText && ( TextAbstraction::COMMON == script ) )
+
+ if(endOfText)
+ {
+ // Last characters of the text are 'white spaces'.
+ // There is nothing else to do. Just add the remaining characters to the last script after this bucle.
+ break;
+ }
- if( TextAbstraction::UNKNOWN == script )
+ // Check if it is the first character of a paragraph.
+ if(isFirstScriptToBeSet &&
+ (TextAbstraction::UNKNOWN != script) &&
+ (TextAbstraction::COMMON != script) &&
+ (TextAbstraction::EMOJI != script))
{
- script = TextAbstraction::LATIN;
- DALI_ASSERT_DEBUG( !"MultilanguageSupport::SetScripts. Unkown script!" );
+ // Sets the direction of the first valid script.
+ isParagraphRTL = currentScriptRun.isRightToLeft || TextAbstraction::IsRightToLeftScript(script);
+ isFirstScriptToBeSet = false;
}
- if( script != currentScriptRun.script )
+ if((script != currentScriptRun.script) &&
+ (TextAbstraction::COMMON != script))
{
// Current run needs to be stored and a new one initialized.
- if( 0u != currentScriptRun.characterRun.numberOfCharacters )
+ if((isParagraphRTL == TextAbstraction::IsRightToLeftScript(currentScriptRun.script)) &&
+ (TextAbstraction::UNKNOWN != currentScriptRun.script))
+ {
+ // Previous script has the same direction than the first script of the paragraph.
+ // All the previously skipped characters need to be added to the previous script before it's stored.
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+ numberOfAllScriptCharacters = 0u;
+ }
+ else if((TextAbstraction::IsRightToLeftScript(currentScriptRun.script) == TextAbstraction::IsRightToLeftScript(script)) &&
+ (TextAbstraction::UNKNOWN != currentScriptRun.script))
+ {
+ // Current script and previous one have the same direction.
+ // All the previously skipped characters need to be added to the previous script before it's stored.
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+ numberOfAllScriptCharacters = 0u;
+ }
+ else if((TextAbstraction::UNKNOWN == currentScriptRun.script) &&
+ (TextAbstraction::EMOJI == script))
+ {
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+ numberOfAllScriptCharacters = 0u;
+ }
+
+ if(0u != currentScriptRun.characterRun.numberOfCharacters)
{
// Store the script run.
- scripts.PushBack( currentScriptRun );
+ scripts.Insert(scripts.Begin() + scriptIndex, currentScriptRun);
+ ++scriptIndex;
}
// Initialize the new one.
- currentScriptRun.characterRun.characterIndex = currentScriptRun.characterRun.characterIndex + currentScriptRun.characterRun.numberOfCharacters;
- currentScriptRun.characterRun.numberOfCharacters = 0u;
- currentScriptRun.script = script;
+ currentScriptRun.characterRun.characterIndex = currentScriptRun.characterRun.characterIndex + currentScriptRun.characterRun.numberOfCharacters;
+ currentScriptRun.characterRun.numberOfCharacters = numberOfAllScriptCharacters + 1u; // Adds the white spaces which are at the begining of the script.
+ currentScriptRun.script = script;
+ numberOfAllScriptCharacters = 0u;
+ // Check if whether is right to left script.
+ currentScriptRun.isRightToLeft = TextAbstraction::IsRightToLeftScript(currentScriptRun.script);
}
+ else
+ {
+ if(TextAbstraction::UNKNOWN != currentScriptRun.script)
+ {
+ // Adds white spaces between characters.
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+ numberOfAllScriptCharacters = 0u;
+ }
- // Add one more character to the run.
- ++currentScriptRun.characterRun.numberOfCharacters;
+ // Add one more character to the run.
+ ++currentScriptRun.characterRun.numberOfCharacters;
+ }
}
- if( 0u != currentScriptRun.characterRun.numberOfCharacters )
+ // Add remaining characters into the last script.
+ currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
+
+ if(0u != currentScriptRun.characterRun.numberOfCharacters)
{
// Store the last run.
- scripts.PushBack( currentScriptRun );
+ scripts.Insert(scripts.Begin() + scriptIndex, currentScriptRun);
+ ++scriptIndex;
+ }
+
+ if(scriptIndex < scripts.Count())
+ {
+ // Update the indices of the next script runs.
+ const ScriptRun& run = *(scripts.Begin() + scriptIndex - 1u);
+ CharacterIndex nextCharacterIndex = run.characterRun.characterIndex + run.characterRun.numberOfCharacters;
+
+ for(Vector<ScriptRun>::Iterator it = scripts.Begin() + scriptIndex,
+ endIt = scripts.End();
+ it != endIt;
+ ++it)
+ {
+ ScriptRun& run = *it;
+ run.characterRun.characterIndex = nextCharacterIndex;
+ nextCharacterIndex += run.characterRun.numberOfCharacters;
+ }
}
}
-void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
- const Vector<ScriptRun>& scripts,
- Vector<FontRun>& fonts )
+void MultilanguageSupport::ValidateFonts(const Vector<Character>& text,
+ const Vector<ScriptRun>& scripts,
+ const Vector<FontDescriptionRun>& fontDescriptions,
+ const TextAbstraction::FontDescription& defaultFontDescription,
+ TextAbstraction::PointSize26Dot6 defaultFontPointSize,
+ CharacterIndex startIndex,
+ Length numberOfCharacters,
+ Vector<FontRun>& fonts)
{
- const Length numberOfCharacters = text.Count();
+ DALI_LOG_INFO(gLogFilter, Debug::General, "-->MultilanguageSupport::ValidateFonts\n");
- if( 0u == numberOfCharacters )
+ if(0u == numberOfCharacters)
{
+ DALI_LOG_INFO(gLogFilter, Debug::General, "<--MultilanguageSupport::ValidateFonts\n");
// Nothing to do if there are no characters.
return;
}
- // Copy the fonts set by application developers.
- const Length numberOfFontRuns = fonts.Count();
- const Vector<FontRun> definedFonts = fonts;
- fonts.Clear();
+ // Find the first index where to insert the font run.
+ FontRunIndex fontIndex = 0u;
+ if(0u != startIndex)
+ {
+ for(Vector<FontRun>::ConstIterator it = fonts.Begin(),
+ endIt = fonts.End();
+ it != endIt;
+ ++it, ++fontIndex)
+ {
+ const FontRun& run = *it;
+ if(startIndex < run.characterRun.characterIndex + run.characterRun.numberOfCharacters)
+ {
+ // Run found.
+ break;
+ }
+ }
+ }
// Traverse the characters and validate/set the fonts.
// Get the caches.
- FontId* defaultFontPerScriptCacheBuffer = mDefaultFontPerScriptCache.Begin();
- ValidateFontsPerScript** validFontsPerScriptCacheBuffer = mValidFontsPerScriptCache.Begin();
+ DefaultFonts** defaultFontPerScriptCacheBuffer = mDefaultFontPerScriptCache.Begin();
+ ValidateFontsPerScript** validFontsPerScriptCacheBuffer = mValidFontsPerScriptCache.Begin();
// Stores the validated font runs.
- fonts.Reserve( numberOfFontRuns );
+ fonts.Reserve(fontDescriptions.Count());
// Initializes a validated font run.
FontRun currentFontRun;
- currentFontRun.characterRun.characterIndex = 0u;
+ currentFontRun.characterRun.characterIndex = startIndex;
currentFontRun.characterRun.numberOfCharacters = 0u;
- currentFontRun.fontId = 0u;
- currentFontRun.isDefault = false;
+ currentFontRun.fontId = 0u;
+ currentFontRun.isBoldRequired = false;
+ currentFontRun.isItalicRequired = false;
// Get the font client.
TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
- // Iterators of the font and script runs.
- Vector<FontRun>::ConstIterator fontRunIt = definedFonts.Begin();
- Vector<FontRun>::ConstIterator fontRunEndIt = definedFonts.End();
- Vector<ScriptRun>::ConstIterator scriptRunIt = scripts.Begin();
- Vector<ScriptRun>::ConstIterator scriptRunEndIt = scripts.End();
+ const Character* const textBuffer = text.Begin();
+
+ // Iterators of the script runs.
+ Vector<ScriptRun>::ConstIterator scriptRunIt = scripts.Begin();
+ Vector<ScriptRun>::ConstIterator scriptRunEndIt = scripts.End();
+ bool isNewParagraphCharacter = false;
- for( Length index = 0u; index < numberOfCharacters; ++index )
+ bool isPreviousEmojiScript = false;
+ FontId previousEmojiFontId = 0u;
+
+ CharacterIndex lastCharacter = startIndex + numberOfCharacters;
+ for(Length index = startIndex; index < lastCharacter; ++index)
{
- // Get the character.
- const Character character = *( text.Begin() + index );
+ // Get the current character.
+ const Character character = *(textBuffer + index);
+ bool isItalicRequired = false;
+ bool isBoldRequired = false;
+
+ // new description for current character
+ TextAbstraction::FontDescription currentFontDescription;
+ TextAbstraction::PointSize26Dot6 currentFontPointSize = defaultFontPointSize;
+ bool isDefaultFont = true;
+ MergeFontDescriptions(fontDescriptions,
+ defaultFontDescription,
+ defaultFontPointSize,
+ index,
+ currentFontDescription,
+ currentFontPointSize,
+ isDefaultFont);
+
+ // Get the font for the current character.
+ FontId fontId = fontClient.GetFontId(currentFontDescription, currentFontPointSize);
+
+ // Get the script for the current character.
+ Script script = GetScript(index,
+ scriptRunIt,
+ scriptRunEndIt);
+
+#ifdef DEBUG_ENABLED
+ {
+ Dali::TextAbstraction::FontDescription description;
+ fontClient.GetDescription(fontId, description);
+
+ DALI_LOG_INFO(gLogFilter,
+ Debug::Verbose,
+ " Initial font set\n Character : %x, Script : %s, Font : %s \n",
+ character,
+ Dali::TextAbstraction::ScriptName[script],
+ description.path.c_str());
+ }
+#endif
+
+ // Validate whether the current character is supported by the given font.
+ bool isValidFont = false;
+
+ // Check first in the cache of default fonts per script and size.
- // Get the font for the character.
- FontId fontId = GetFontId( index,
- fontRunIt,
- fontRunEndIt );
+ FontId cachedDefaultFontId = 0u;
+ DefaultFonts* defaultFonts = *(defaultFontPerScriptCacheBuffer + script);
+ if(NULL != defaultFonts)
+ {
+ // This cache stores fall-back fonts.
+ cachedDefaultFontId = defaultFonts->FindFont(fontClient,
+ currentFontDescription,
+ currentFontPointSize);
+ }
+
+ // Whether the cached default font is valid.
+ const bool isValidCachedDefaultFont = 0u != cachedDefaultFontId;
- // Get the script for the character.
- Script script = GetScript( index,
- scriptRunIt,
- scriptRunEndIt );
+ // The font is valid if it matches with the default one for the current script and size and it's different than zero.
+ isValidFont = isValidCachedDefaultFont && (fontId == cachedDefaultFontId);
- if( TextAbstraction::UNKNOWN == script )
+ if(isValidFont)
{
- DALI_LOG_WARNING( "MultilanguageSupport::ValidateFonts. Unknown script!" );
- script = TextAbstraction::LATIN;
+ // Check if the font supports the character.
+ isValidFont = fontClient.IsCharacterSupportedByFont(fontId, character);
}
- // Whether the font being validated is a default one not set by the user.
- const bool isDefault = ( 0u == fontId );
+ bool isCommonScript = false;
+ bool isEmojiScript = TextAbstraction::EMOJI == script;
+
+ if(isEmojiScript && !isPreviousEmojiScript)
+ {
+ if(0u != currentFontRun.characterRun.numberOfCharacters)
+ {
+ // Store the font run.
+ fonts.Insert(fonts.Begin() + fontIndex, currentFontRun);
+ ++fontIndex;
+ }
- // The default font point size.
- PointSize26Dot6 pointSize = TextAbstraction::FontClient::DEFAULT_POINT_SIZE;
+ // Initialize the new one.
+ currentFontRun.characterRun.characterIndex = currentFontRun.characterRun.characterIndex + currentFontRun.characterRun.numberOfCharacters;
+ currentFontRun.characterRun.numberOfCharacters = 0u;
+ currentFontRun.fontId = fontId;
+ currentFontRun.isItalicRequired = false;
+ currentFontRun.isBoldRequired = false;
+ }
- if( !isDefault )
+ // ZWJ, ZWNJ between emojis should use the previous emoji font.
+ if(isEmojiScript && (TextAbstraction::IsZeroWidthJoiner(character) || TextAbstraction::IsZeroWidthNonJoiner(character)))
{
- // Validate if the font set by the user supports the character.
+ if(0u != previousEmojiFontId)
+ {
+ fontId = previousEmojiFontId;
+ isValidFont = true;
+ }
+ }
- // Check first in the caches.
+ // If the given font is not valid, it means either:
+ // - there is no cached font for the current script yet or,
+ // - the user has set a different font than the default one for the current script or,
+ // - the platform default font is different than the default font for the current script.
- // The user may have set the default font. Check it. Otherwise check in the valid fonts cache.
- if( fontId != *( defaultFontPerScriptCacheBuffer + script ) )
+ // Need to check if the given font supports the current character.
+ if(!isValidFont) // (1)
+ {
+ // Whether the current character is common for all scripts (i.e. white spaces, ...)
+
+ // Is not desirable to cache fonts for the common script.
+ //
+ // i.e. Consider the text " हिंदी", the 'white space' has assigned the DEVANAGARI script.
+ // The user may have set a font or the platform's default is used.
+ //
+ // As the 'white space' is the first character, no font is cached so the font validation
+ // retrieves a glyph from the given font.
+ //
+ // Many fonts support 'white spaces' so probably the font set by the user or the platform's default
+ // supports the 'white space'. However, that font may not support the DEVANAGARI script.
+ isCommonScript = TextAbstraction::IsCommonScript(character);
+
+ // Check in the valid fonts cache.
+ ValidateFontsPerScript* validateFontsPerScript = *(validFontsPerScriptCacheBuffer + script);
+
+ if(NULL != validateFontsPerScript)
{
- // Check in the valid fonts cache.
- ValidateFontsPerScript* validateFontsPerScript = *( validFontsPerScriptCacheBuffer + script );
- if( NULL != validateFontsPerScript )
+ // This cache stores valid fonts set by the user.
+ isValidFont = validateFontsPerScript->IsValidFont(fontId);
+
+ // It may happen that a validated font for a script doesn't have all the glyphs for that script.
+ // i.e a font validated for the CJK script may contain glyphs for the chinese language but not for the Japanese.
+ if(isValidFont)
{
- if( !validateFontsPerScript->FindValidFont( fontId ) )
- {
- // Use the font client to validate the font.
- const GlyphIndex glyphIndex = fontClient.GetGlyphIndex( fontId, character );
+ // Checks if the current character is supported by the font is needed.
+ isValidFont = fontClient.IsCharacterSupportedByFont(fontId, character);
+ }
+ }
- if( 0u == glyphIndex )
- {
- // Get the point size of the current font. It will be used to get a default font id.
- pointSize = fontClient.GetPointSize( fontId );
+ if(!isValidFont) // (2)
+ {
+ // The selected font is not stored in any cache.
- // The font is not valid. Set to zero and a default one will be set.
- fontId = 0u;
- }
- else
- {
- // Add the font to the valid font cache.
- validateFontsPerScript->mValidFonts.PushBack( fontId );
- }
+ // Checks if the current character is supported by the selected font.
+ isValidFont = fontClient.IsCharacterSupportedByFont(fontId, character);
+
+ // If there is a valid font, cache it.
+ if(isValidFont && !isCommonScript)
+ {
+ if(NULL == validateFontsPerScript)
+ {
+ validateFontsPerScript = new ValidateFontsPerScript();
+
+ *(validFontsPerScriptCacheBuffer + script) = validateFontsPerScript;
}
+
+ validateFontsPerScript->mValidFonts.PushBack(fontId);
}
- else
+
+ if(!isValidFont && (fontId != cachedDefaultFontId) && (!TextAbstraction::IsNewParagraph(character))) // (3)
{
- // Use the font client to validate the font.
- const GlyphIndex glyphIndex = fontClient.GetGlyphIndex( fontId, character );
+ // The selected font by the user or the platform's default font has failed to validate the character.
- if( 0u == glyphIndex )
+ // Checks if the previously discarted cached default font supports the character.
+ bool isValidCachedFont = false;
+ if(isValidCachedDefaultFont)
{
- // Get the point size of the current font. It will be used to get a default font id.
- pointSize = fontClient.GetPointSize( fontId );
+ isValidCachedFont = fontClient.IsCharacterSupportedByFont(cachedDefaultFontId, character);
+ }
- // The font is not valid. Set to zero and a default one will be set.
- fontId = 0u;
+ if(isValidCachedFont)
+ {
+ // Use the cached default font for the script if there is one.
+ fontId = cachedDefaultFontId;
}
else
{
- // Add the font to the valid font cache.
- validateFontsPerScript = new ValidateFontsPerScript();
- *( validFontsPerScriptCacheBuffer + script ) = validateFontsPerScript;
+ // There is no valid cached default font for the script.
+
+ DefaultFonts* defaultFontsPerScript = NULL;
- validateFontsPerScript->mValidFonts.PushBack( fontId );
+ // Find a fallback-font.
+ fontId = fontClient.FindFallbackFont(character,
+ currentFontDescription,
+ currentFontPointSize,
+ false);
+
+ if(0u == fontId)
+ {
+ fontId = fontClient.FindDefaultFont(UTF32_A, currentFontPointSize);
+ }
+
+ if(!isCommonScript && (script != TextAbstraction::UNKNOWN))
+ {
+ // Cache the font if it is not an unknown script
+ if(NULL == defaultFontsPerScript)
+ {
+ defaultFontsPerScript = *(defaultFontPerScriptCacheBuffer + script);
+
+ if(NULL == defaultFontsPerScript)
+ {
+ defaultFontsPerScript = new DefaultFonts();
+ *(defaultFontPerScriptCacheBuffer + script) = defaultFontsPerScript;
+ }
+ }
+ defaultFontsPerScript->Cache(currentFontDescription, fontId);
+ }
}
- }
+ } // !isValidFont (3)
+ } // !isValidFont (2)
+ } // !isValidFont (1)
+
+ // Store the font id when the first character is an emoji.
+ if(isEmojiScript && !isPreviousEmojiScript)
+ {
+ if(0u != fontId)
+ {
+ previousEmojiFontId = fontId;
}
}
- // The font has not been validated. Find a default one.
- if( 0u == fontId )
+#ifdef DEBUG_ENABLED
{
- // The character has no font assigned. Get a default one from the cache
- fontId = *( defaultFontPerScriptCacheBuffer + script );
+ Dali::TextAbstraction::FontDescription description;
+ fontClient.GetDescription(fontId, description);
+ DALI_LOG_INFO(gLogFilter,
+ Debug::Verbose,
+ " Validated font set\n Character : %x, Script : %s, Font : %s \n",
+ character,
+ Dali::TextAbstraction::ScriptName[script],
+ description.path.c_str());
+ }
+#endif
- // If the cache has not a default font, get one from the font client.
- if( 0u == fontId )
- {
- // Find a default font.
- fontId = fontClient.FindDefaultFont( character, pointSize );
+ // Whether bols style is required.
+ isBoldRequired = (currentFontDescription.weight >= TextAbstraction::FontWeight::BOLD);
- // Cache the font.
- *( defaultFontPerScriptCacheBuffer + script ) = fontId;
- }
- }
+ // Whether italic style is required.
+ isItalicRequired = (currentFontDescription.slant >= TextAbstraction::FontSlant::ITALIC);
// The font is now validated.
-
- if( ( fontId != currentFontRun.fontId ) ||
- ( isDefault != currentFontRun.isDefault ) )
+ if((fontId != currentFontRun.fontId) ||
+ isNewParagraphCharacter ||
+ // If font id is same as previous but style is diffrent, initialize new one
+ ((fontId == currentFontRun.fontId) && ((isBoldRequired != currentFontRun.isBoldRequired) || (isItalicRequired != currentFontRun.isItalicRequired))))
{
// Current run needs to be stored and a new one initialized.
- if( 0u != currentFontRun.characterRun.numberOfCharacters )
+ if(0u != currentFontRun.characterRun.numberOfCharacters)
{
// Store the font run.
- fonts.PushBack( currentFontRun );
+ fonts.Insert(fonts.Begin() + fontIndex, currentFontRun);
+ ++fontIndex;
}
// Initialize the new one.
- currentFontRun.characterRun.characterIndex = currentFontRun.characterRun.characterIndex + currentFontRun.characterRun.numberOfCharacters;
+ currentFontRun.characterRun.characterIndex = currentFontRun.characterRun.characterIndex + currentFontRun.characterRun.numberOfCharacters;
currentFontRun.characterRun.numberOfCharacters = 0u;
- currentFontRun.fontId = fontId;
- currentFontRun.isDefault = isDefault;
+ currentFontRun.fontId = fontId;
+ currentFontRun.isBoldRequired = isBoldRequired;
+ currentFontRun.isItalicRequired = isItalicRequired;
}
// Add one more character to the run.
++currentFontRun.characterRun.numberOfCharacters;
- }
- if( 0u != currentFontRun.characterRun.numberOfCharacters )
+ // Whether the current character is a new paragraph character.
+ isNewParagraphCharacter = TextAbstraction::IsNewParagraph(character);
+ isPreviousEmojiScript = isEmojiScript;
+ } // end traverse characters.
+
+ if(0u != currentFontRun.characterRun.numberOfCharacters)
{
// Store the last run.
- fonts.PushBack( currentFontRun );
+ fonts.Insert(fonts.Begin() + fontIndex, currentFontRun);
+ ++fontIndex;
}
+
+ if(fontIndex < fonts.Count())
+ {
+ // Update the indices of the next font runs.
+ const FontRun& run = *(fonts.Begin() + fontIndex - 1u);
+ CharacterIndex nextCharacterIndex = run.characterRun.characterIndex + run.characterRun.numberOfCharacters;
+
+ for(Vector<FontRun>::Iterator it = fonts.Begin() + fontIndex,
+ endIt = fonts.End();
+ it != endIt;
+ ++it)
+ {
+ FontRun& run = *it;
+
+ run.characterRun.characterIndex = nextCharacterIndex;
+ nextCharacterIndex += run.characterRun.numberOfCharacters;
+ }
+ }
+
+ DALI_LOG_INFO(gLogFilter, Debug::General, "<--MultilanguageSupport::ValidateFonts\n");
}
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff