1 #ifndef DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H
2 #define DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
25 #include <dali/public-api/object/base-handle.h>
26 #include <dali/public-api/actors/actor-enumerations.h>
29 #include <dali/public-api/dali-adaptor-common.h>
34 namespace TextAbstraction
37 namespace Internal DALI_INTERNAL
40 class BidirectionalSupport;
45 * BidirectionalSupport API
48 class DALI_ADAPTOR_API BidirectionalSupport : public BaseHandle
54 * @brief Create an uninitialized TextAbstraction handle.
57 BidirectionalSupport();
62 * This is non-virtual since derived Handle types must not contain data or virtual methods.
64 ~BidirectionalSupport();
67 * @brief This constructor is used by BidirectionalSupport::Get().
69 * @param[in] implementation a pointer to the internal bidirectional support object.
71 explicit DALI_INTERNAL BidirectionalSupport( Internal::BidirectionalSupport* implementation );
74 * @brief Retrieve a handle to the BidirectionalSupport instance.
76 * @return A handle to the BidirectionalSupport
78 static BidirectionalSupport Get();
81 * @brief Creates bidirectional data for the whole paragraph.
83 * @param[in] paragraph Pointer to the first character of the paragraph coded in UTF32.
84 * @param[in] numberOfCharacters The number of characters of the paragraph.
85 * @param[in] matchSystemLanguageDirection Whether match for system language direction or not.
86 * @param[in] layoutDirection The direction of the system language.
87 * @return An index of an object inside a table storing the bidirectional data.
89 BidiInfoIndex CreateInfo( const Character* const paragraph,
90 Length numberOfCharacters,
91 bool matchSystemLanguageDirection,
92 LayoutDirection::Type layoutDirection );
95 * @brief Destroys the bidirectional data.
97 * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
99 void DestroyInfo( BidiInfoIndex bidiInfoIndex );
102 * @brief Reorders a line of a paragraph.
104 * @pre visualToLogicalMap must have enough space allocated for @p numberOfCharacters.
106 * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
107 * @param[in] firstCharacterIndex The first character of the line within the whole paragraph.
108 * @param[in] numberOfCharacters The number of characters of the line.
109 * @param[out] visualToLogicalMap The visual to logical conversion map.
111 void Reorder( BidiInfoIndex bidiInfoIndex,
112 CharacterIndex firstCharacterIndex,
113 Length numberOfCharacters,
114 CharacterIndex* visualToLogicalMap );
117 * @brief Replaces any character which could be mirrored.
119 * @param[in,out] text The text.
120 * @param[in] directions The direction of each paragraph.
121 * @param[in] numberOfCharacters The number of characters.
123 * @return @e true if a character has been replaced.
125 bool GetMirroredText( Character* text,
126 CharacterDirection* directions,
127 Length numberOfCharacters );
130 * @brief Retrieves the paragrpah's direction.
132 * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
134 * @return @e true if the paragraph is right to left, otherwise @e false.
136 bool GetParagraphDirection( BidiInfoIndex bidiInfoIndex ) const;
139 * @brief Retrieves the character's directions.
141 * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
142 * @param[out] directions The direction, @e false is left to right and @e true is right to left, of each character of the paragraph.
143 * @param[in] numberOfCharacters The number of characters.
145 void GetCharactersDirection( BidiInfoIndex bidiInfoIndex,
146 CharacterDirection* directions,
147 Length numberOfCharacters );
150 } // namespace TextAbstraction
154 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H