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