dali-toolkit/internal/text/markup-processor.h

   1 #ifndef DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H
   2 #define DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/anchor.h>
  27 #include <dali-toolkit/internal/text/bounded-paragraph-run.h>
  28 #include <dali-toolkit/internal/text/character-spacing-character-run.h>
  29 #include <dali-toolkit/internal/text/color-run.h>
  30 #include <dali-toolkit/internal/text/embedded-item.h>
  31 #include <dali-toolkit/internal/text/font-description-run.h>
  32 #include <dali-toolkit/internal/text/strikethrough-character-run.h>
  33 #include <dali-toolkit/internal/text/underlined-character-run.h>
  34
  35 namespace Dali
  36 {
  37 namespace Toolkit
  38 {
  39 namespace Text
  40 {
  41 /**
  42  * @brief Keeps the plain text and references to vectors from the model which stores runs with text styles.
  43  */
  44 struct MarkupProcessData
  45 {
  46   MarkupProcessData(Vector<ColorRun>&                     colorRuns,
  47                     Vector<FontDescriptionRun>&           fontRuns,
  48                     Vector<EmbeddedItem>&                 items,
  49                     Vector<Anchor>&                       anchors,
  50                     Vector<UnderlinedCharacterRun>&       underlinedCharacterRuns,
  51                     Vector<ColorRun>&                     backgroundColorRuns,
  52                     Vector<StrikethroughCharacterRun>&    strikethroughCharacterRuns,
  53                     Vector<BoundedParagraphRun>&          boundedParagraphRuns,
  54                     Vector<CharacterSpacingCharacterRun>& characterSpacingCharacterRuns)
  55   : colorRuns(colorRuns),
  56     fontRuns(fontRuns),
  57     items(items),
  58     anchors(anchors),
  59     underlinedCharacterRuns(underlinedCharacterRuns),
  60     backgroundColorRuns(backgroundColorRuns),
  61     strikethroughCharacterRuns(strikethroughCharacterRuns),
  62     boundedParagraphRuns(boundedParagraphRuns),
  63     characterSpacingCharacterRuns(characterSpacingCharacterRuns),
  64     markupProcessedText()
  65   {
  66   }
  67
  68   Vector<ColorRun>&                     colorRuns;                     ///< The color runs.
  69   Vector<FontDescriptionRun>&           fontRuns;                      ///< The font description runs.
  70   Vector<EmbeddedItem>&                 items;                         ///< The embedded items.
  71   Vector<Anchor>&                       anchors;                       ///< The anchors.
  72   Vector<UnderlinedCharacterRun>&       underlinedCharacterRuns;       ///< The underlined character runs.
  73   Vector<ColorRun>&                     backgroundColorRuns;           ///< The background color runs.
  74   Vector<StrikethroughCharacterRun>&    strikethroughCharacterRuns;    ///< The strikethrough character runs.
  75   Vector<BoundedParagraphRun>&          boundedParagraphRuns;          ///< The bounded paragraph runs
  76   Vector<CharacterSpacingCharacterRun>& characterSpacingCharacterRuns; ///< The character-spacing runs
  77
  78   std::string markupProcessedText; ///< The mark-up string.
  79 };
  80
  81 /**
  82  * @brief Process the mark-up string.
  83  *
  84  * @param[in] markupString The mark-up string.
  85  * @param[out] markupProcessData The plain text and the style.
  86  */
  87 void ProcessMarkupString(const std::string& markupString, MarkupProcessData& markupProcessData);
  88
  89 } // namespace Text
  90
  91 } // namespace Toolkit
  92
  93 } // namespace Dali
  94
  95 #endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H