[dali_1.1.25] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / shaper.h
1 #ifndef __DALI_TOOLKIT_TEXT_SHAPER_H__
2 #define __DALI_TOOLKIT_TEXT_SHAPER_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 // EXTERNAL INCLUDES
22 #include <dali/public-api/common/dali-vector.h>
23
24 // INTERNAL INCLUDES
25 #include <dali-toolkit/internal/text/font-run.h>
26 #include <dali-toolkit/internal/text/script-run.h>
27
28 namespace Dali
29 {
30
31 namespace Toolkit
32 {
33
34 namespace Text
35 {
36
37 class LogicalModel;
38 class VisualModel;
39
40 /**
41  * Shapes the whole text.
42  *
43  * @param[in] text Vector of UTF-32 characters.
44  * @param[in] lineBreakInfo The line break info.
45  * @param[in] scripts Vector containing the script runs for the whole text.
46  * @param[in] fonts Vector with validated fonts.
47  * @param[in] startCharacterIndex The character from where the text is shaped.
48  * @param[in] startGlyphIndex The glyph from where the text is shaped.
49  * @param[in] numberOfCharacters The number of characters to be shaped.
50  * @param[out] glyphs Vector of glyphs in the visual order.
51  * @param[out] glyphToCharacterMap Vector containing the first character in the logical model that each glyph relates to.
52  * @param[out] charactersPerGlyph Vector containing the number of characters per glyph.
53  * @param[out] newParagraphGlyphs Vector containing the indices to the new paragraph glyphs.
54  */
55 void ShapeText( const Vector<Character>& text,
56                 const Vector<LineBreakInfo>& lineBreakInfo,
57                 const Vector<ScriptRun>& scripts,
58                 const Vector<FontRun>& fonts,
59                 CharacterIndex startCharacterIndex,
60                 GlyphIndex startGlyphIndex,
61                 Length numberOfCharacters,
62                 Vector<GlyphInfo>& glyphs,
63                 Vector<CharacterIndex>& glyphToCharacterMap,
64                 Vector<Length>& charactersPerGlyph,
65                 Vector<GlyphIndex>& newParagraphGlyphs );
66
67 } // namespace Text
68
69 } // namespace Toolkit
70
71 } // namespace Dali
72
73 #endif // __DALI_TOOLKIT_TEXT_SHAPER_H__