2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/text/rendering/view-model.h>
22 #include <dali/devel-api/text-abstraction/font-client.h>
26 #include <dali-toolkit/internal/text/line-run.h>
34 ViewModel::ViewModel(const ModelInterface* const model)
42 ViewModel::~ViewModel()
46 const Size& ViewModel::GetControlSize() const
48 return mModel->GetControlSize();
51 const Size& ViewModel::GetLayoutSize() const
53 return mModel->GetLayoutSize();
56 const Vector2& ViewModel::GetScrollPosition() const
58 return mModel->GetScrollPosition();
61 HorizontalAlignment::Type ViewModel::GetHorizontalAlignment() const
63 return mModel->GetHorizontalAlignment();
66 VerticalAlignment::Type ViewModel::GetVerticalAlignment() const
68 return mModel->GetVerticalAlignment();
71 DevelText::VerticalLineAlignment::Type ViewModel::GetVerticalLineAlignment() const
73 return mModel->GetVerticalLineAlignment();
76 bool ViewModel::IsTextElideEnabled() const
78 return mModel->IsTextElideEnabled();
81 Length ViewModel::GetNumberOfLines() const
83 return mModel->GetNumberOfLines();
86 const LineRun* const ViewModel::GetLines() const
88 return mModel->GetLines();
91 Length ViewModel::GetNumberOfScripts() const
93 return mModel->GetNumberOfScripts();
96 const ScriptRun* const ViewModel::GetScriptRuns() const
98 return mModel->GetScriptRuns();
101 Length ViewModel::GetNumberOfGlyphs() const
103 if(mIsTextElided && mModel->IsTextElideEnabled())
105 return mElidedGlyphs.Count();
109 return mModel->GetNumberOfGlyphs();
115 const GlyphInfo* const ViewModel::GetGlyphs() const
117 if(mIsTextElided && mModel->IsTextElideEnabled())
119 return mElidedGlyphs.Begin();
123 return mModel->GetGlyphs();
129 const Vector2* const ViewModel::GetLayout() const
131 if(mIsTextElided && mModel->IsTextElideEnabled())
133 return mElidedLayout.Begin();
137 return mModel->GetLayout();
143 const Vector4* const ViewModel::GetColors() const
145 return mModel->GetColors();
148 const ColorIndex* const ViewModel::GetColorIndices() const
150 return mModel->GetColorIndices();
153 const Vector4* const ViewModel::GetBackgroundColors() const
155 return mModel->GetBackgroundColors();
158 const ColorIndex* const ViewModel::GetBackgroundColorIndices() const
160 return mModel->GetBackgroundColorIndices();
163 const Vector4& ViewModel::GetDefaultColor() const
165 return mModel->GetDefaultColor();
168 const Vector2& ViewModel::GetShadowOffset() const
170 return mModel->GetShadowOffset();
173 const Vector4& ViewModel::GetShadowColor() const
175 return mModel->GetShadowColor();
178 const float& ViewModel::GetShadowBlurRadius() const
180 return mModel->GetShadowBlurRadius();
183 const Vector4& ViewModel::GetUnderlineColor() const
185 return mModel->GetUnderlineColor();
188 bool ViewModel::IsUnderlineEnabled() const
190 return mModel->IsUnderlineEnabled();
193 float ViewModel::GetUnderlineHeight() const
195 return mModel->GetUnderlineHeight();
198 Length ViewModel::GetNumberOfUnderlineRuns() const
200 return mModel->GetNumberOfUnderlineRuns();
203 void ViewModel::GetUnderlineRuns(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const
205 mModel->GetUnderlineRuns(underlineRuns, index, numberOfRuns);
208 const Vector4& ViewModel::GetOutlineColor() const
210 return mModel->GetOutlineColor();
213 uint16_t ViewModel::GetOutlineWidth() const
215 return mModel->GetOutlineWidth();
218 const Vector4& ViewModel::GetBackgroundColor() const
220 return mModel->GetBackgroundColor();
223 bool ViewModel::IsBackgroundEnabled() const
225 return mModel->IsBackgroundEnabled();
228 bool ViewModel::IsMarkupProcessorEnabled() const
230 return mModel->IsMarkupProcessorEnabled();
233 const GlyphInfo* ViewModel::GetHyphens() const
235 return mModel->GetHyphens();
238 const Length* ViewModel::GetHyphenIndices() const
240 return mModel->GetHyphenIndices();
243 Length ViewModel::GetHyphensCount() const
245 return mModel->GetHyphensCount();
248 void ViewModel::ElideGlyphs()
250 mIsTextElided = false;
252 if(mModel->IsTextElideEnabled())
254 const Length numberOfLines = mModel->GetNumberOfLines();
255 if(0u != numberOfLines)
257 const LineRun* const lines = mModel->GetLines();
259 const LineRun& lastLine = *(lines + (numberOfLines - 1u));
260 const Length numberOfLaidOutGlyphs = lastLine.glyphRun.glyphIndex + lastLine.glyphRun.numberOfGlyphs;
262 if(lastLine.ellipsis && (0u != numberOfLaidOutGlyphs))
264 mIsTextElided = true;
265 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
267 const GlyphInfo* const glyphs = mModel->GetGlyphs();
268 const Vector2* const positions = mModel->GetLayout();
270 // Copy the glyphs to be elided.
271 mElidedGlyphs.Resize(numberOfLaidOutGlyphs);
272 mElidedLayout.Resize(numberOfLaidOutGlyphs);
274 GlyphInfo* elidedGlyphsBuffer = mElidedGlyphs.Begin();
275 Vector2* elidedPositionsBuffer = mElidedLayout.Begin();
277 memcpy(elidedGlyphsBuffer, glyphs, numberOfLaidOutGlyphs * sizeof(GlyphInfo));
278 memcpy(elidedPositionsBuffer, positions, numberOfLaidOutGlyphs * sizeof(Vector2));
280 const Size& controlSize = mModel->GetControlSize();
282 if((1u == numberOfLines) &&
283 (lastLine.ascender - lastLine.descender > controlSize.height))
285 // Get the first glyph which is going to be replaced and the ellipsis glyph.
286 GlyphInfo& glyphToRemove = *elidedGlyphsBuffer;
287 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphToRemove.fontId));
289 // Change the 'x' and 'y' position of the ellipsis glyph.
290 Vector2& position = *elidedPositionsBuffer;
292 position.x = ellipsisGlyph.xBearing;
293 position.y = -lastLine.ascender + controlSize.height - ellipsisGlyph.yBearing;
295 // Replace the glyph by the ellipsis glyph and resize the buffers.
296 glyphToRemove = ellipsisGlyph;
298 mElidedGlyphs.Resize(1u);
299 mElidedLayout.Resize(1u);
304 // firstPenX, penY and firstPenSet are used to position the ellipsis glyph if needed.
305 float firstPenX = 0.f; // Used if rtl text is elided.
307 bool firstPenSet = false;
309 // Add the ellipsis glyph.
310 bool inserted = false;
311 float removedGlypsWidth = 0.f;
312 Length numberOfRemovedGlyphs = 0u;
313 GlyphIndex index = numberOfLaidOutGlyphs - 1u;
315 // The ellipsis glyph has to fit in the place where the last glyph(s) is(are) removed.
318 const GlyphInfo& glyphToRemove = *(elidedGlyphsBuffer + index);
320 if(0u != glyphToRemove.fontId)
322 // i.e. The font id of the glyph shaped from the '\n' character is zero.
324 // Need to reshape the glyph as the font may be different in size.
325 const GlyphInfo& ellipsisGlyph = fontClient.GetEllipsisGlyph(fontClient.GetPointSize(glyphToRemove.fontId));
327 if(!firstPenSet || EqualsZero(glyphToRemove.advance))
329 const Vector2& position = *(elidedPositionsBuffer + index);
331 // Calculates the penY of the current line. It will be used to position the ellipsis glyph.
332 penY = position.y + glyphToRemove.yBearing;
334 // Calculates the first penX which will be used if rtl text is elided.
335 firstPenX = position.x - glyphToRemove.xBearing;
336 if(firstPenX < -ellipsisGlyph.xBearing)
338 // Avoids to exceed the bounding box when rtl text is elided.
339 firstPenX = -ellipsisGlyph.xBearing;
342 removedGlypsWidth = -ellipsisGlyph.xBearing;
344 if(!EqualsZero(firstPenX))
350 removedGlypsWidth += std::min(glyphToRemove.advance, (glyphToRemove.xBearing + glyphToRemove.width));
352 // Calculate the width of the ellipsis glyph and check if it fits.
353 const float ellipsisGlyphWidth = ellipsisGlyph.width + ellipsisGlyph.xBearing;
355 // If it is the last glyph to remove, add the ellipsis glyph without checking its width.
356 if((ellipsisGlyphWidth < removedGlypsWidth) || (index == 0u))
358 GlyphInfo& glyphInfo = *(elidedGlyphsBuffer + index);
359 Vector2& position = *(elidedPositionsBuffer + index);
360 position.x -= (0.f > glyphInfo.xBearing) ? glyphInfo.xBearing : 0.f;
362 // Replace the glyph by the ellipsis glyph.
363 glyphInfo = ellipsisGlyph;
365 // Change the 'x' and 'y' position of the ellipsis glyph.
366 if(position.x > firstPenX)
368 position.x = firstPenX;
369 if(ellipsisGlyphWidth < removedGlypsWidth)
371 position.x += removedGlypsWidth - ellipsisGlyphWidth;
375 position.x += ellipsisGlyph.xBearing;
376 position.y = penY - ellipsisGlyph.yBearing;
390 // No space for the ellipsis.
393 ++numberOfRemovedGlyphs;
395 } // while( !inserted )
397 // 'Removes' all the glyphs after the ellipsis glyph.
398 const Length numberOfGlyphs = numberOfLaidOutGlyphs - numberOfRemovedGlyphs;
399 mElidedGlyphs.Resize(numberOfGlyphs);
400 mElidedLayout.Resize(numberOfGlyphs);
408 } // namespace Toolkit