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