LibreOffice Module sw (master) 1
justify.cxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 */
9
10#include <vector>
11#include <sal/types.h>
12#include <swfont.hxx>
13#include "justify.hxx"
14
15namespace
16{
17enum class IdeographicPunctuationClass
18{
19 NONE,
20 OPEN_BRACKET,
21 CLOSE_BRACKET,
22 COMMA_OR_FULLSTOP
23};
24
25IdeographicPunctuationClass lcl_WhichPunctuationClass(sal_Unicode cChar)
26{
27 if ((cChar < 0x3001 || cChar > 0x3002) && (cChar < 0x3008 || cChar > 0x3011)
28 && (cChar < 0x3014 || cChar > 0x301F) && 0xFF62 != cChar && 0xFF63 != cChar)
30 else if (0x3001 == cChar || 0x3002 == cChar)
31 return IdeographicPunctuationClass::COMMA_OR_FULLSTOP;
32 else if (0x3009 == cChar || 0x300B == cChar || 0x300D == cChar || 0x300F == cChar
33 || 0x3011 == cChar || 0x3015 == cChar || 0x3017 == cChar || 0x3019 == cChar
34 || 0x301B == cChar || 0x301E == cChar || 0x301F == cChar || 0xFF63 == cChar)
35 // right punctuation
36 return IdeographicPunctuationClass::CLOSE_BRACKET;
37
38 return IdeographicPunctuationClass::OPEN_BRACKET;
39}
40
41tools::Long lcl_MinGridWidth(tools::Long nGridWidth, tools::Long nCharWidth)
42{
43 tools::Long nCount = nCharWidth > nGridWidth ? (nCharWidth - 1) / nGridWidth + 1 : 1;
44 return nCount * nGridWidth;
45}
46
47tools::Long lcl_OffsetFromGridEdge(tools::Long nMinWidth, tools::Long nCharWidth, sal_Unicode cChar,
48 bool bForceLeft)
49{
50 if (bForceLeft)
51 return 0;
52
53 tools::Long nOffset = 0;
54
55 switch (lcl_WhichPunctuationClass(cChar))
56 {
58 // Centered
59 nOffset = (nMinWidth - nCharWidth) / 2;
60 break;
61 case IdeographicPunctuationClass::OPEN_BRACKET:
62 // Align to next edge, closer to next ideograph
63 nOffset = nMinWidth - nCharWidth;
64 break;
65 default:
66 // CLOSE_BRACKET or COMMA_OR_FULLSTOP:
67 // Align to previous edge, closer to previous ideograph.
68 break;
69 }
70 return nOffset;
71}
72}
73
74namespace sw::Justify
75{
76sal_Int32 GetModelPosition(const std::vector<sal_Int32>& rKernArray, sal_Int32 nLen, tools::Long nX)
77{
78 tools::Long nLeft = 0, nRight = 0;
79 sal_Int32 nLast = 0, nIdx = 0;
80
81 do
82 {
83 nRight = rKernArray[nLast];
84 ++nIdx;
85 while (nIdx < nLen && rKernArray[nIdx] == rKernArray[nLast])
86 ++nIdx;
87
88 if (nIdx < nLen)
89 {
90 if (nX < nRight)
91 return (nX - nLeft < nRight - nX) ? nLast : nIdx;
92
93 nLeft = nRight;
94 nLast = nIdx;
95 }
96 } while (nIdx < nLen);
97 return nIdx;
98}
99
100void SpaceDistribution(std::vector<sal_Int32>& rKernArray, std::u16string_view aText,
101 sal_Int32 nStt, sal_Int32 nLen, tools::Long nSpaceAdd, tools::Long nKern,
102 bool bNoHalfSpace)
103{
104 assert(nStt + nLen <= sal_Int32(aText.size()));
105 assert(nLen <= sal_Int32(rKernArray.size()));
106 // nSpaceSum contains the sum of the intermediate space distributed
107 // among Spaces by the Justification.
108 // The Spaces themselves will be positioned in the middle of the
109 // intermediate space, hence the nSpace/2.
110 // In case of word-by-word underlining they have to be positioned
111 // at the beginning of the intermediate space, so that the space
112 // is not underlined.
113 // A Space at the beginning or end of the text must be positioned
114 // before (resp. after) the whole intermediate space, otherwise
115 // the underline/strike-through would have gaps.
116 tools::Long nSpaceSum = 0;
117 // in word line mode and for Arabic, we disable the half space trick:
118 const tools::Long nHalfSpace = bNoHalfSpace ? 0 : nSpaceAdd / 2;
119 const tools::Long nOtherHalf = nSpaceAdd - nHalfSpace;
120 tools::Long nKernSum = nKern;
121 sal_Unicode cChPrev = aText[nStt];
122
123 if (nSpaceAdd && (cChPrev == CH_BLANK))
124 nSpaceSum = nHalfSpace;
125
126 sal_Int32 nPrevIdx = 0;
127
128 for (sal_Int32 i = 1; i < nLen; ++i, nKernSum += nKern)
129 {
130 // Find the beginning of the next cluster that has a different kern value.
131 while (i < nLen && rKernArray[i] == rKernArray[nPrevIdx])
132 ++i;
133
134 if (i == nLen)
135 break;
136
137 sal_Unicode nCh = aText[nStt + i];
138
139 // Apply SpaceSum
140 if (cChPrev == CH_BLANK)
141 {
142 // no Pixel is lost:
143 nSpaceSum += nOtherHalf;
144 }
145
146 if (nCh == CH_BLANK)
147 {
148 if (i + 1 == nLen)
149 nSpaceSum += nSpaceAdd;
150 else
151 nSpaceSum += nHalfSpace;
152 }
153
154 cChPrev = nCh;
155 rKernArray[nPrevIdx] += nKernSum + nSpaceSum;
156 // In word line mode and for Arabic, we disabled the half space trick. If a portion
157 // ends with a blank, the full nSpaceAdd value has been added to the character in
158 // front of the blank. This leads to painting artifacts, therefore we remove the
159 // nSpaceAdd value again:
160 if (bNoHalfSpace && i + 1 == nLen && nCh == CH_BLANK)
161 rKernArray[nPrevIdx] = rKernArray[nPrevIdx] - nSpaceAdd;
162
163 // Advance nPrevIdx and assign kern values to previous cluster.
164 for (tools::Long nValue = rKernArray[nPrevIdx++]; nPrevIdx < i; ++nPrevIdx)
165 rKernArray[nPrevIdx] = nValue;
166 }
167
168 // the layout engine requires the total width of the output
169 while (nPrevIdx < nLen)
170 rKernArray[nPrevIdx++] += nKernSum + nSpaceSum;
171}
172
173tools::Long SnapToGrid(std::vector<sal_Int32>& rKernArray, std::u16string_view aText,
174 sal_Int32 nStt, sal_Int32 nLen, tools::Long nGridWidth, bool bForceLeft)
175{
176 assert(nStt + nLen <= sal_Int32(aText.size()));
177 assert(nLen <= sal_Int32(rKernArray.size()));
178
179 tools::Long nCharWidth = rKernArray[0];
180 tools::Long nMinWidth = lcl_MinGridWidth(nGridWidth, nCharWidth);
181 tools::Long nDelta = lcl_OffsetFromGridEdge(nMinWidth, nCharWidth, aText[nStt], bForceLeft);
182 tools::Long nEdge = nMinWidth - nDelta;
183
184 sal_Int32 nLast = 0;
185
186 for (sal_Int32 i = 1; i < nLen; ++i)
187 {
188 if (rKernArray[i] == rKernArray[nLast])
189 continue;
190
191 nCharWidth = rKernArray[i] - rKernArray[nLast];
192 nMinWidth = lcl_MinGridWidth(nGridWidth, nCharWidth);
193 tools::Long nX
194 = nEdge + lcl_OffsetFromGridEdge(nMinWidth, nCharWidth, aText[nStt + i], bForceLeft);
195 nEdge += nMinWidth;
196
197 while (nLast < i)
198 rKernArray[nLast++] = nX;
199 }
200
201 while (nLast < nLen)
202 rKernArray[nLast++] = nEdge;
203
204 return nDelta;
205}
206
207void SnapToGridEdge(std::vector<sal_Int32>& rKernArray, sal_Int32 nLen, tools::Long nGridWidth,
208 tools::Long nSpace, tools::Long nKern)
209{
210 assert(nLen <= sal_Int32(rKernArray.size()));
211
212 tools::Long nCharWidth = rKernArray[0];
213 tools::Long nEdge = lcl_MinGridWidth(nGridWidth, nCharWidth + nKern) + nSpace;
214
215 sal_Int32 nLast = 0;
216
217 for (sal_Int32 i = 1; i < nLen; ++i)
218 {
219 if (rKernArray[i] == rKernArray[nLast])
220 continue;
221
222 nCharWidth = rKernArray[i] - rKernArray[nLast];
223 tools::Long nMinWidth = lcl_MinGridWidth(nGridWidth, nCharWidth + nKern);
224 while (nLast < i)
225 rKernArray[nLast++] = nEdge;
226
227 nEdge += nMinWidth + nSpace;
228 }
229
230 while (nLast < nLen)
231 rKernArray[nLast++] = nEdge;
232}
233}
234
235/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
int nCount
sal_Int16 nValue
int i
tools::Long SnapToGrid(std::vector< sal_Int32 > &rKernArray, std::u16string_view aText, sal_Int32 nStt, sal_Int32 nLen, tools::Long nGridWidth, bool bForceLeft)
Snap ideographs to text grids: a) Ideographic open brackets are aligned to the rightmost edge of span...
Definition: justify.cxx:173
void SnapToGridEdge(std::vector< sal_Int32 > &rKernArray, sal_Int32 nLen, tools::Long nGridWidth, tools::Long nSpace, tools::Long nKern)
Snap ideographs to text grids edge ( used when snap to char is off ): space will be distributed ( in ...
Definition: justify.cxx:207
sal_Int32 GetModelPosition(const std::vector< sal_Int32 > &rKernArray, sal_Int32 nLen, tools::Long nX)
Get model position base on given kern array.
Definition: justify.cxx:76
void SpaceDistribution(std::vector< sal_Int32 > &rKernArray, std::u16string_view aText, sal_Int32 nStt, sal_Int32 nLen, tools::Long nSpaceAdd, tools::Long nKern, bool bNoHalfSpace)
Distribute space between words and letters.
Definition: justify.cxx:100
long Long
const sal_Unicode CH_BLANK
Definition: swfont.hxx:42
sal_uInt16 sal_Unicode