eee808412513d370547d5ba3b1bc0b29c86034c4
[platform/core/uifw/dali-adaptor.git] / text / dali / public-api / text-abstraction / bidirectional-support.h
1 #ifndef __DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H__
2 #define __DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H__
3
4 /*
5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
22 #include <dali/public-api/text-abstraction/text-abstraction.h>
23
24 // EXTERNAL INCLUDES
25 #include <dali/public-api/object/base-handle.h>
26
27 namespace Dali
28 {
29
30 namespace Internal DALI_INTERNAL
31 {
32
33 namespace TextAbstraction
34 {
35 class BidirectionalSupport;
36 } // TextAbstraction
37 } // Internal
38
39 namespace TextAbstraction
40 {
41
42
43 /**
44  * BidirectionalSupport API
45  *
46  */
47 class DALI_IMPORT_API BidirectionalSupport : public BaseHandle
48 {
49
50 public:
51
52   /**
53    * @brief Create an uninitialized TextAbstraction handle.
54    *
55    */
56   BidirectionalSupport();
57
58   /**
59    * @brief Destructor
60    *
61    * This is non-virtual since derived Handle types must not contain data or virtual methods.
62    */
63   ~BidirectionalSupport();
64
65   /**
66    * @brief This constructor is used by BidirectionalSupport::Get().
67    *
68    * @param[in] implementation a pointer to the internal bidirectional support object.
69    */
70   explicit DALI_INTERNAL BidirectionalSupport( Dali::Internal::TextAbstraction::BidirectionalSupport* implementation );
71
72   /**
73    * @brief Retrieve a handle to the BidirectionalSupport instance.
74    *
75    * @return A handle to the BidirectionalSupport
76    */
77   static BidirectionalSupport Get();
78
79   /**
80    * @brief Creates bidirectional data for the whole paragraph.
81    *
82    * @param[in] paragraph Pointer to the first character of the paragraph coded in UTF32.
83    * @param[in] numberOfCharacters The number of characters of the paragraph.
84    *
85    * @return An index of an object inside a table storing the bidirectional data.
86    */
87   BidiInfoIndex CreateInfo( const Character* const paragraph,
88                             Length numberOfCharacters );
89
90   /**
91    * @brief Destroys the bidirectional data.
92    *
93    * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
94    */
95   void DestroyInfo( BidiInfoIndex bidiInfoIndex );
96
97   /**
98    * @brief Reorders a line of a paragraph.
99    *
100    * @pre visualToLogicalMap must have enough space allocated for @p numberOfCharacters.
101    *
102    * @param[in] bidiInfoIndex The index to the of the object inside the table storing the bidirectional data for the current paragraph.
103    * @param[in] firstCharacterIndex The first character of the line within the whole paragraph.
104    * @param[in] numberOfCharacters The number of characters of the line.
105    * @param[out] visualToLogicalMap The visual to logical conversion map.
106    */
107   void Reorder( BidiInfoIndex bidiInfoIndex,
108                 CharacterIndex firstCharacterIndex,
109                 Length numberOfCharacters,
110                 CharacterIndex* visualToLogicalMap );
111 };
112
113 } // namespace TextAbstraction
114
115 } // namespace Dali
116
117 #endif // __DALI_PLATFORM_TEXT_ABSTRACTION_BIDIRECTIONAL_SUPPORT_H__