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/color-run.h>
  28 #include <dali-toolkit/internal/text/embedded-item.h>
  29 #include <dali-toolkit/internal/text/font-description-run.h>
  30 #include <dali-toolkit/internal/text/strikethrough-character-run.h>
  31 #include <dali-toolkit/internal/text/underlined-character-run.h>
  32
  33 namespace Dali
  34 {
  35 namespace Toolkit
  36 {
  37 namespace Text
  38 {
  39 /**
  40  * @brief Keeps the plain text and references to vectors from the model which stores runs with text styles.
  41  */
  42 struct MarkupProcessData
  43 {
  44   MarkupProcessData(Vector<ColorRun>&                  colorRuns,
  45                     Vector<FontDescriptionRun>&        fontRuns,
  46                     Vector<EmbeddedItem>&              items,
  47                     Vector<Anchor>&                    anchors,
  48                     Vector<UnderlinedCharacterRun>&    underlinedCharacterRuns,
  49                     Vector<ColorRun>&                  backgroundColorRuns,
  50                     Vector<StrikethroughCharacterRun>& strikethroughCharacterRuns)
  51   : colorRuns(colorRuns),
  52     fontRuns(fontRuns),
  53     items(items),
  54     anchors(anchors),
  55     underlinedCharacterRuns(underlinedCharacterRuns),
  56     backgroundColorRuns(backgroundColorRuns),
  57     strikethroughCharacterRuns(strikethroughCharacterRuns),
  58     markupProcessedText()
  59   {
  60   }
  61
  62   Vector<ColorRun>&                  colorRuns;                  ///< The color runs.
  63   Vector<FontDescriptionRun>&        fontRuns;                   ///< The font description runs.
  64   Vector<EmbeddedItem>&              items;                      ///< The embedded items.
  65   Vector<Anchor>&                    anchors;                    ///< The anchors.
  66   Vector<UnderlinedCharacterRun>&    underlinedCharacterRuns;    ///< The underlined character runs.
  67   Vector<ColorRun>&                  backgroundColorRuns;        ///< The background color runs.
  68   Vector<StrikethroughCharacterRun>& strikethroughCharacterRuns; ///< The strikethrough character runs.
  69   std::string                        markupProcessedText;        ///< The mark-up string.
  70 };
  71
  72 /**
  73  * @brief Process the mark-up string.
  74  *
  75  * @param[in] markupString The mark-up string.
  76  * @param[out] markupProcessData The plain text and the style.
  77  */
  78 void ProcessMarkupString(const std::string& markupString, MarkupProcessData& markupProcessData);
  79
  80 } // namespace Text
  81
  82 } // namespace Toolkit
  83
  84 } // namespace Dali
  85
  86 #endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H