Spannable: Add BackgroundSpan
[platform/core/uifw/dali-toolkit.git] / automated-tests / src / dali-toolkit-internal / utc-Dali-Text-TextSpannable.cpp
index ebc4041..6af7bb0 100644 (file)
 #include <dali-toolkit/dali-toolkit.h>
 #include <dali-toolkit/devel-api/controls/text-controls/text-spannable.h>
 #include <dali-toolkit/devel-api/text/spannable-string.h>
+#include <dali-toolkit/devel-api/text/spans/font-span.h>
 #include <dali-toolkit/devel-api/text/spans/foreground-color-span.h>
+#include <dali-toolkit/devel-api/text/spans/underline-span.h>
+#include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
 #include <dali-toolkit/internal/controls/text-controls/text-editor-impl.h>
 #include <dali-toolkit/internal/controls/text-controls/text-field-impl.h>
 #include <dali-toolkit/internal/controls/text-controls/text-label-impl.h>
+#include <dali-toolkit/internal/text/controller/text-controller.h>
+#include <dali-toolkit/internal/text/font-description-run.h>
+#include <dali-toolkit/internal/text/rendering/text-typesetter.h>
+#include <dali-toolkit/internal/text/rendering/view-model.h>
+#include <dali-toolkit/internal/text/text-view.h>
+#include <dali-toolkit/public-api/text/text-enumerations.h>
+#include <toolkit-text-utils.h>
+#include <dali-toolkit/devel-api/text/spans/character-spacing-span.h>
+#include <dali-toolkit/devel-api/text/spans/bold-span.h>
+#include <dali-toolkit/devel-api/text/spans/italic-span.h>
+#include <dali-toolkit/devel-api/text/spans/background-color-span.h>
 
 using namespace Dali;
 using namespace Toolkit;
 
+namespace
+{
+const std::string DEFAULT_FONT_DIR("/resources/fonts");
+const float       PIXEL_FORMAT_64_FACTOR = 64.f; ///< 64.f is used to convert from point size to 26.6 pixel format.
+} // namespace
+
 Text::SpannableString CreateSpannableStringForForegroundColorSpan()
 {
   Text::SpannableString spannableString = Text::SpannableString::New("Hello مرحبا");
@@ -41,10 +61,89 @@ Text::SpannableString CreateSpannableStringForForegroundColorSpan()
     Text::Range::New(5u, 7u));
   DALI_TEST_CHECK(isAddedGreen);
 
-  auto isAddedBlue = spannableString.AttachSpan(
-    Text::ForegroundColorSpan::New(Color::BLUE),
-    Text::Range::New(1u, 2u));
-  DALI_TEST_CHECK(isAddedBlue);
+  return spannableString;
+}
+
+Text::SpannableString CreateSpannableStringForFontSpan()
+{
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello World");
+  DALI_TEST_CHECK(spannableString);
+
+  auto isAddedFontSpan = spannableString.AttachSpan(
+    Text::FontSpan::New("TizenSans",
+                        45.0f,
+                        Dali::TextAbstraction::FontWeight::BOLD,
+                        Dali::TextAbstraction::FontWidth::SEMI_CONDENSED,
+                        Dali::TextAbstraction::FontSlant::OBLIQUE),
+    Text::Range::New(5u, 7u));
+  DALI_TEST_CHECK(isAddedFontSpan);
+
+  return spannableString;
+}
+
+Text::SpannableString CreateSpannableStringForUnderlineSpan()
+{
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello World");
+  DALI_TEST_CHECK(spannableString);
+
+  auto isAddedUnderlineSpan = spannableString.AttachSpan(
+    Text::UnderlineSpan::NewDashed(Color::GREEN, 5.0f, 2.0f, 3.0f),
+    Text::Range::New(5u, 7u));
+  DALI_TEST_CHECK(isAddedUnderlineSpan);
+
+  return spannableString;
+}
+
+Text::SpannableString CreateSpannableStringForCharacterSpacing()
+{
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello World");
+  DALI_TEST_CHECK(spannableString);
+
+  auto isCharacterSpacingSpan = spannableString.AttachSpan(
+  Text::CharacterSpacingSpan::New(5.2f),
+  Text::Range::New(5u, 7u));
+  DALI_TEST_CHECK(isCharacterSpacingSpan);
+
+  return spannableString;
+}
+
+Text::SpannableString CreateSpannableStringForBoldSpan()
+{
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello");
+  DALI_TEST_CHECK(spannableString);
+
+  auto boldspan = Dali::Toolkit::Text::BoldSpan::New();
+  auto isBoldSpan = spannableString.AttachSpan(boldspan,Dali::Toolkit::Text::Range::New(0u, 3u));
+  DALI_TEST_CHECK(isBoldSpan);
+
+  return spannableString;
+
+}
+
+Text::SpannableString CreateSpannableStringForItalicSpan()
+{
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello");
+  DALI_TEST_CHECK(spannableString);
+
+  auto isAddedItalic = spannableString.AttachSpan(
+  Text::ItalicSpan::New(),
+  Text::Range::New(0u, 3u));
+  DALI_TEST_CHECK(isAddedItalic);
+
+  return spannableString;
+}
+
+Text::SpannableString CreateSpannableStringForBackgroundColorSpan()
+{
+
+  Text::SpannableString spannableString = Text::SpannableString::New("Hello مرحبا");
+
+  DALI_TEST_CHECK(spannableString);
+
+  auto isAddedGreen = spannableString.AttachSpan(
+  Text::BackgroundColorSpan::New(Color::GREEN),
+  Text::Range::New(5u, 7u));
+  DALI_TEST_CHECK(isAddedGreen);
 
   return spannableString;
 }
@@ -78,10 +177,10 @@ int UtcDaliToolkitTextLabelSetSpannedText(void)
   application.SendNotification();
   application.Render();
 
-  Toolkit::Internal::TextLabel& labelImpl           = GetImpl(textLabel);
-  const Text::ColorIndex* const colorIndicesBuffer  = labelImpl.GetTextController()->GetTextModel()->GetColorIndices();
+  Toolkit::Internal::TextLabel& labelImpl          = GetImpl(textLabel);
+  const Text::ColorIndex* const colorIndicesBuffer = labelImpl.GetTextController()->GetTextModel()->GetColorIndices();
 
-  CheckColorIndices(colorIndicesBuffer, 6u, {0u, 1u, 2u, 5u, 7u, 10u}, {0u, 2u, 2u, 1u, 1u, 0u});
+  CheckColorIndices(colorIndicesBuffer, 4u, {0u, 5u, 7u, 10u}, {0u, 1u, 1u, 0u});
 
   END_TEST;
 }
@@ -105,7 +204,7 @@ int UtcDaliToolkitTextEditorSetSpannedText(void)
   Toolkit::Internal::TextEditor& labelImpl          = GetImpl(textEditor);
   const Text::ColorIndex* const  colorIndicesBuffer = labelImpl.GetTextController()->GetTextModel()->GetColorIndices();
 
-  CheckColorIndices(colorIndicesBuffer, 6u, {0u, 1u, 2u, 5u, 7u, 10u}, {0u, 2u, 2u, 1u, 1u, 0u});
+  CheckColorIndices(colorIndicesBuffer, 4u, {0u, 5u, 7u, 10u}, {0u, 1u, 1u, 0u});
 
   END_TEST;
 }
@@ -129,7 +228,298 @@ int UtcDaliToolkitTextFieldSetSpannedText(void)
   Toolkit::Internal::TextField& labelImpl          = GetImpl(textField);
   const Text::ColorIndex* const colorIndicesBuffer = labelImpl.GetTextController()->GetTextModel()->GetColorIndices();
 
-  CheckColorIndices(colorIndicesBuffer, 6u, {0u, 1u, 2u, 5u, 7u, 10u}, {0u, 2u, 2u, 1u, 1u, 0u});
+  CheckColorIndices(colorIndicesBuffer, 4u, {0u, 5u, 7u, 10u}, {0u, 1u, 1u, 0u});
+
+  END_TEST;
+}
+
+int UtcDaliToolkitTextLabelSetSpannedText_FontSpan(void)
+{
+  ToolkitTestApplication application;
+  tet_infoline(" UtcDaliToolkitTextLabelSetSpannedText_FontSpan ");
+
+  // Load some fonts to get the same metrics on different platforms.
+  TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
+  fontClient.SetDpi(96u, 96u);
+
+  char*             pathNamePtr = get_current_dir_name();
+  const std::string pathName(pathNamePtr);
+  free(pathNamePtr);
+
+  fontClient.GetFontId(pathName + DEFAULT_FONT_DIR + "/tizen/TizenSansRegular.ttf");
+
+  TextLabel textLabel = TextLabel::New();
+  DALI_TEST_CHECK(textLabel);
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForFontSpan();
+
+  Text::SetSpannedText(textLabel, spannableString);
+
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel&               labelImpl     = GetImpl(textLabel);
+  const Vector<Dali::Toolkit::Text::FontRun>& validFontRuns = labelImpl.GetTextController()->GetTextModel()->GetFontRuns();
+
+  DALI_TEST_EQUALS(validFontRuns.Count(), 3u, TEST_LOCATION);
+
+  DALI_TEST_EQUALS(validFontRuns[0].fontId, validFontRuns[2].fontId, TEST_LOCATION);
+  DALI_TEST_NOT_EQUALS(validFontRuns[0].fontId, validFontRuns[1].fontId, Math::MACHINE_EPSILON_100, TEST_LOCATION);
+
+  DALI_TEST_EQUALS(validFontRuns[1].characterRun.characterIndex, 5u, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontRuns[1].characterRun.GetEndCharacterIndex(), 7u, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontRuns[1].isItalicRequired, true, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontRuns[1].isBoldRequired, true, TEST_LOCATION);
+
+  TextAbstraction::FontDescription spanFontDescription;
+
+  float expectedPointSize = 45.0f * PIXEL_FORMAT_64_FACTOR;
+  float fontPointSize     = fontClient.GetPointSize(validFontRuns[1].fontId);
+  DALI_TEST_EQUALS(fontPointSize, expectedPointSize, TEST_LOCATION);
+
+  const Vector<Dali::Toolkit::Text::FontDescriptionRun>& validFontDescriptionRuns = labelImpl.GetTextController()->GetTextModel()->GetFontDescriptionRuns();
+  DALI_TEST_EQUALS(validFontDescriptionRuns.Count(), 1u, TEST_LOCATION);
+  std::string familyName = validFontDescriptionRuns[0].familyName;
+
+  DALI_TEST_EQUALS(familyName, "TizenSans", TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontDescriptionRuns[0].size, expectedPointSize, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontDescriptionRuns[0].weight, Dali::TextAbstraction::FontWeight::BOLD, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontDescriptionRuns[0].width, Dali::TextAbstraction::FontWidth::SEMI_CONDENSED, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontDescriptionRuns[0].slant, Dali::TextAbstraction::FontSlant::OBLIQUE, TEST_LOCATION);
+
+  END_TEST;
+}
+
+int UtcDaliTextModelIsSpannedTextPlaced(void)
+
+{
+  tet_infoline(" UtcDaliTextModelIsSpannedTextPlaced");
+
+  ToolkitTestApplication application;
+
+  // Create spanned-text and set it
+  Text::SpannableString spannedText = Text::SpannableString::New("Hello مرحبا");
+  DALI_TEST_CHECK(spannedText);
+
+  // Creates a text controller.
+  Dali::Toolkit::Text::ControllerPtr         controllerTextEditor = Dali::Toolkit::Text::Controller::New();
+  const Dali::Toolkit::Text::ModelInterface* modelEditor          = controllerTextEditor->GetTextModel();
+
+  // Tests the rendering controller has been created.
+  Dali::Toolkit::Text::TypesetterPtr typesetterEditor = Dali::Toolkit::Text::Typesetter::New(controllerTextEditor->GetTextModel());
+  DALI_TEST_CHECK(typesetterEditor);
+
+  // Tests the view model has been created.
+  Dali::Toolkit::Text::ViewModel* viewModelEditor = typesetterEditor->GetViewModel();
+  DALI_TEST_CHECK(viewModelEditor);
+
+  // Configures the text controller similarly to the text-editor.
+  Dali::Toolkit::Text::ConfigureTextEditor(controllerTextEditor);
+
+  DALI_TEST_EQUALS(false, modelEditor->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(false, viewModelEditor->IsSpannedTextPlaced(), TEST_LOCATION);
+
+  controllerTextEditor->SetSpannedText(spannedText);
+
+  DALI_TEST_EQUALS(true, modelEditor->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(true, viewModelEditor->IsSpannedTextPlaced(), TEST_LOCATION);
+
+  // Creates a text controller.
+  Dali::Toolkit::Text::ControllerPtr         controllerTextLabel = Dali::Toolkit::Text::Controller::New();
+  const Dali::Toolkit::Text::ModelInterface* modelLabel          = controllerTextLabel->GetTextModel();
+
+  // Tests the rendering controller has been created.
+  Dali::Toolkit::Text::TypesetterPtr typesetterLabel = Dali::Toolkit::Text::Typesetter::New(controllerTextLabel->GetTextModel());
+  DALI_TEST_CHECK(typesetterLabel);
+
+  // Tests the view model has been created.
+  Dali::Toolkit::Text::ViewModel* viewModelLabel = typesetterLabel->GetViewModel();
+  DALI_TEST_CHECK(viewModelLabel);
+
+  // Configures the text controller similarly to the text-label.
+  Dali::Toolkit::Text::ConfigureTextLabel(controllerTextLabel);
+
+  DALI_TEST_EQUALS(false, modelLabel->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(false, viewModelLabel->IsSpannedTextPlaced(), TEST_LOCATION);
+
+  controllerTextLabel->SetSpannedText(spannedText);
+
+  DALI_TEST_EQUALS(true, modelLabel->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(true, viewModelLabel->IsSpannedTextPlaced(), TEST_LOCATION);
 
+  // Creates a text controller.
+  Dali::Toolkit::Text::ControllerPtr         controllerTextField = Dali::Toolkit::Text::Controller::New();
+  const Dali::Toolkit::Text::ModelInterface* modelField          = controllerTextField->GetTextModel();
+
+  // Tests the rendering controller has been created.
+  Dali::Toolkit::Text::TypesetterPtr typesetterField = Dali::Toolkit::Text::Typesetter::New(controllerTextField->GetTextModel());
+  DALI_TEST_CHECK(typesetterField);
+
+  // Tests the view model has been created.
+  Dali::Toolkit::Text::ViewModel* viewModelField = typesetterField->GetViewModel();
+  DALI_TEST_CHECK(viewModelField);
+
+  // Configures the text controller similarly to the text-field.
+  Dali::Toolkit::Text::ConfigureTextField(controllerTextField);
+
+  DALI_TEST_EQUALS(false, modelField->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(false, viewModelField->IsSpannedTextPlaced(), TEST_LOCATION);
+
+  controllerTextField->SetSpannedText(spannedText);
+
+  DALI_TEST_EQUALS(true, modelField->IsSpannedTextPlaced(), TEST_LOCATION);
+  DALI_TEST_EQUALS(true, viewModelField->IsSpannedTextPlaced(), TEST_LOCATION);
+
+  tet_result(TET_PASS);
+
+  END_TEST;
+}
+
+int UtcDaliToolkitTextLabelSetSpannedText_UnderlineSpan(void)
+{
+  ToolkitTestApplication application;
+  tet_infoline(" UtcDaliToolkitTextLabelSetSpannedText_UnderlineSpan ");
+
+  Dali::Toolkit::Text::UnderlineStyleProperties expectedProperties = {
+    Text::Underline::DASHED,
+    Color::GREEN,
+    5u,
+    2u,
+    3u,
+    true,
+    true,
+    true,
+    true,
+    true};
+
+  TextLabel textLabel = TextLabel::New();
+  DALI_TEST_CHECK(textLabel);
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForUnderlineSpan();
+
+  Text::SetSpannedText(textLabel, spannableString);
+
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel& labelImpl             = GetImpl(textLabel);
+  const Text::Length            numberOfUnderlineRuns = labelImpl.GetTextController()->GetTextModel()->GetNumberOfUnderlineRuns();
+
+  DALI_TEST_EQUALS(numberOfUnderlineRuns, 1u, TEST_LOCATION);
+
+  Vector<Dali::Toolkit::Text::UnderlinedGlyphRun> underlineRuns;
+
+  underlineRuns.Resize(numberOfUnderlineRuns);
+
+  labelImpl.GetTextController()->GetTextModel()->GetUnderlineRuns(underlineRuns.Begin(), 0u, numberOfUnderlineRuns);
+
+  DALI_TEST_EQUALS(underlineRuns[0].glyphRun.glyphIndex, 5u, TEST_LOCATION);
+  DALI_TEST_EQUALS(underlineRuns[0].glyphRun.numberOfGlyphs, 3u, TEST_LOCATION);
+  DALI_TEST_CHECK(underlineRuns[0].properties == expectedProperties);
+
+  END_TEST;
+}
+
+int UtcDaliToolkitTextLabelSetSpannedText_CharacterSpacingSpan(void)
+{
+  ToolkitTestApplication application;
+  tet_infoline("UtcDaliToolkitTextLabelSetSpannedText_CharacterSpacingSpan");
+
+  TextLabel textLabel = TextLabel::New();
+  DALI_TEST_CHECK(textLabel);
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForCharacterSpacing();
+  Text::SetSpannedText(textLabel, spannableString);
+
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel& labelImpl   = GetImpl(textLabel);
+  const Vector<Dali::Toolkit::Text::CharacterSpacingGlyphRun> characterSpacing = labelImpl.GetTextController()->GetTextModel()->GetCharacterSpacingGlyphRuns();
+  DALI_TEST_EQUALS(1, characterSpacing.Count(), TEST_LOCATION);
+  END_TEST;
+}
+
+int UtcDaliToolkitTextLabelSetSpannedText_BoldSpan(void)
+{
+  ToolkitTestApplication application;
+
+  tet_infoline("UtcDaliToolkitTextLabelSetSpannedText_BoldSpan");
+
+  TextLabel textLabel = TextLabel::New();
+
+  DALI_TEST_CHECK(textLabel);
+
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForBoldSpan();
+  Text::SetSpannedText(textLabel, spannableString);
+
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel&               labelImpl  = GetImpl(textLabel);
+
+  const Vector<Text::FontRun>& validFonts = labelImpl.GetTextController()->GetTextModel()->GetFontRuns();
+
+  DALI_TEST_EQUALS(validFonts.Count(), 2, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFonts[0].characterRun.characterIndex,0, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFonts[0].characterRun.GetEndCharacterIndex(),3, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFonts[0].isBoldRequired, true, TEST_LOCATION);
   END_TEST;
 }
+
+int UtcDaliToolkitTextLabelSetSpannedText_ItalicSpan(void)
+{
+  ToolkitTestApplication application;
+  tet_infoline("UtcDaliToolkitTextLabelSetSpannedText_ItalicSpan");
+
+  TextLabel textLabel = TextLabel::New();
+  DALI_TEST_CHECK(textLabel);
+
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForItalicSpan();
+
+  Text::SetSpannedText(textLabel, spannableString);
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel& labelImpl       = GetImpl(textLabel);
+  const Vector<Text::FontRun>& validFontsItalic = labelImpl.GetTextController()->GetTextModel()->GetFontRuns();
+
+  DALI_TEST_EQUALS(validFontsItalic.Count(), 2, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontsItalic[0].characterRun.characterIndex, 0, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontsItalic[0].characterRun.GetEndCharacterIndex(), 3, TEST_LOCATION);
+  DALI_TEST_EQUALS(validFontsItalic[0].isItalicRequired, true, TEST_LOCATION);
+  END_TEST;
+}
+
+int UtcDaliToolkitTextLabelSetSpannedText_BackgroundColorSpan(void)
+{
+
+  ToolkitTestApplication application;
+  tet_infoline("UtcDaliToolkitTextLabelSetSpannedText_BackgroundColorSpan");
+
+  TextLabel textLabel = TextLabel::New();
+  DALI_TEST_CHECK(textLabel);
+
+  application.GetScene().Add(textLabel);
+
+  Text::SpannableString spannableString = CreateSpannableStringForBackgroundColorSpan();
+  Text::SetSpannedText(textLabel, spannableString);
+
+  application.SendNotification();
+  application.Render();
+
+  Toolkit::Internal::TextLabel& labelImpl          = GetImpl(textLabel);
+  const Text::ColorIndex* const backgroundColorIndicesBuffer  = labelImpl.GetTextController()->GetTextModel()->GetBackgroundColorIndices();
+
+  CheckColorIndices(backgroundColorIndicesBuffer, 4u, {0u, 5u, 7u, 10u}, {0u, 1u, 1u, 0u});
+
+  END_TEST;
+}
+