summaryrefslogtreecommitdiffstats
path: root/vcl/source/accessibility/AccessibleTextAttributeHelper.cxx
blob: 5647dc972ba5013a5f34c3d99634d227ec977568 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#include <vcl/accessibility/AccessibleTextAttributeHelper.hxx>

#include <com/sun/star/accessibility/AccessibleTextType.hpp>
#include <com/sun/star/accessibility/XAccessibleTextMarkup.hpp>
#include <com/sun/star/awt/FontSlant.hpp>
#include <com/sun/star/awt/FontStrikeout.hpp>
#include <com/sun/star/awt/FontUnderline.hpp>
#include <com/sun/star/awt/FontWeight.hpp>
#include <com/sun/star/style/ParagraphAdjust.hpp>
#include <com/sun/star/text/TextMarkupType.hpp>
#include <o3tl/any.hxx>
#include <tools/color.hxx>

namespace
{
OUString lcl_ConvertCharEscapement(sal_Int16 nEscapement)
{
    if (nEscapement > 0)
        return "super";
    if (nEscapement < 0)
        return "sub";

    return "baseline";
}

OUString lcl_ConverCharStrikeout(sal_Int16 nStrikeout)
{
    OUString sTextLineThroughStyle;
    OUString sTextLineThroughText;
    OUString sTextLineThroughType;
    OUString sTextLineThroughWidth;

    switch (nStrikeout)
    {
        case css::awt::FontStrikeout::BOLD:
            sTextLineThroughType = "single";
            sTextLineThroughWidth = "bold";
            break;
        case css::awt::FontStrikeout::DONTKNOW:
            break;
        case css::awt::FontStrikeout::DOUBLE:
            sTextLineThroughType = "double";
            break;
        case css::awt::FontStrikeout::NONE:
            sTextLineThroughStyle = "none";
            break;
        case css::awt::FontStrikeout::SINGLE:
            sTextLineThroughType = "single";
            break;
        case css::awt::FontStrikeout::SLASH:
            sTextLineThroughText = u"/"_ustr;
            break;
        case css::awt::FontStrikeout::X:
            sTextLineThroughText = u"X"_ustr;
            break;
        default:
            assert(false && "Unhandled strikeout type");
    }

    OUString sResult;
    if (!sTextLineThroughStyle.isEmpty())
        sResult += u"text-line-through-style:"_ustr + sTextLineThroughStyle + ";";
    if (!sTextLineThroughText.isEmpty())
        sResult += u"text-line-through-text:"_ustr + sTextLineThroughText + ";";
    if (!sTextLineThroughType.isEmpty())
        sResult += u"text-line-through-type:"_ustr + sTextLineThroughType + ";";
    if (!sTextLineThroughWidth.isEmpty())
        sResult += u"text-line-through-width:"_ustr + sTextLineThroughWidth + ";";

    return sResult;
}

OUString lcl_convertFontWeight(double fontWeight)
{
    if (fontWeight == css::awt::FontWeight::THIN || fontWeight == css::awt::FontWeight::ULTRALIGHT)
        return "100";
    if (fontWeight == css::awt::FontWeight::LIGHT)
        return "200";
    if (fontWeight == css::awt::FontWeight::SEMILIGHT)
        return "300";
    if (fontWeight == css::awt::FontWeight::NORMAL)
        return "normal";
    if (fontWeight == css::awt::FontWeight::SEMIBOLD)
        return "500";
    if (fontWeight == css::awt::FontWeight::BOLD)
        return "bold";
    if (fontWeight == css::awt::FontWeight::ULTRABOLD)
        return "800";
    if (fontWeight == css::awt::FontWeight::BLACK)
        return "900";

    // awt::FontWeight::DONTKNOW || fontWeight == awt::FontWeight::NORMAL
    return "normal";
}

OUString lcl_ConvertFontSlant(css::awt::FontSlant eFontSlant)
{
    switch (eFontSlant)
    {
        case css::awt::FontSlant::FontSlant_NONE:
            return "normal";
        case css::awt::FontSlant::FontSlant_OBLIQUE:
        case css::awt::FontSlant::FontSlant_REVERSE_OBLIQUE:
            return "oblique";
        case css::awt::FontSlant::FontSlant_ITALIC:
        case css::awt::FontSlant::FontSlant_REVERSE_ITALIC:
            return "italic";
        case css::awt::FontSlant::FontSlant_DONTKNOW:
        case css::awt::FontSlant::FontSlant_MAKE_FIXED_SIZE:
        default:
            return "";
    }
}

// s. https://wiki.linuxfoundation.org/accessibility/iaccessible2/textattributes
// for values
void lcl_ConvertFontUnderline(sal_Int16 nFontUnderline, OUString& rUnderlineStyle,
                              OUString& rUnderlineType, OUString& rUnderlineWidth)
{
    rUnderlineStyle = u""_ustr;
    rUnderlineType = u"single"_ustr;
    rUnderlineWidth = u"auto"_ustr;

    switch (nFontUnderline)
    {
        case css::awt::FontUnderline::BOLD:
            rUnderlineWidth = u"bold"_ustr;
            return;
        case css::awt::FontUnderline::BOLDDASH:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"dash"_ustr;
            return;
        case css::awt::FontUnderline::BOLDDASHDOT:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"dot-dash"_ustr;
            return;
        case css::awt::FontUnderline::BOLDDASHDOTDOT:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"dot-dot-dash"_ustr;
            return;
        case css::awt::FontUnderline::BOLDDOTTED:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"dotted"_ustr;
            return;
        case css::awt::FontUnderline::BOLDLONGDASH:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"long-dash"_ustr;
            return;
        case css::awt::FontUnderline::BOLDWAVE:
            rUnderlineWidth = u"bold"_ustr;
            rUnderlineStyle = u"wave"_ustr;
            return;
        case css::awt::FontUnderline::DASH:
            rUnderlineStyle = u"dash"_ustr;
            return;
        case css::awt::FontUnderline::DASHDOT:
            rUnderlineStyle = u"dot-dash"_ustr;
            return;
        case css::awt::FontUnderline::DASHDOTDOT:
            rUnderlineStyle = u"dot-dot-dash"_ustr;
            return;
        case css::awt::FontUnderline::DONTKNOW:
            rUnderlineWidth = u""_ustr;
            rUnderlineStyle = u""_ustr;
            rUnderlineType = u""_ustr;
            return;
        case css::awt::FontUnderline::DOTTED:
            rUnderlineStyle = u"dotted"_ustr;
            return;
        case css::awt::FontUnderline::DOUBLE:
            rUnderlineType = u"double"_ustr;
            return;
        case css::awt::FontUnderline::DOUBLEWAVE:
            rUnderlineStyle = u"wave"_ustr;
            rUnderlineType = u"double"_ustr;
            return;
        case css::awt::FontUnderline::LONGDASH:
            rUnderlineStyle = u"long-dash"_ustr;
            return;
        case css::awt::FontUnderline::NONE:
            rUnderlineWidth = u"none"_ustr;
            rUnderlineStyle = u"none"_ustr;
            rUnderlineType = u"none"_ustr;
            return;
        case css::awt::FontUnderline::SINGLE:
            rUnderlineType = u"single"_ustr;
            return;
        case css::awt::FontUnderline::SMALLWAVE:
        case css::awt::FontUnderline::WAVE:
            rUnderlineStyle = u"wave"_ustr;
            return;
        default:
            assert(false && "Unhandled font underline type");
    }
}

/** Converts Color to "rgb(r,g,b)" as specified in https://wiki.linuxfoundation.org/accessibility/iaccessible2/textattributes. */
OUString lcl_ConvertColor(Color aColor)
{
    return u"rgb(" + OUString::number(aColor.GetRed()) + u"\\,"
           + OUString::number(aColor.GetGreen()) + u"\\," + OUString::number(aColor.GetBlue())
           + u")";
}

OUString lcl_ConvertParagraphAdjust(css::style::ParagraphAdjust eParaAdjust)
{
    switch (eParaAdjust)
    {
        case css::style::ParagraphAdjust_LEFT:
            return u"left"_ustr;
        case css::style::ParagraphAdjust_RIGHT:
            return u"right"_ustr;
        case css::style::ParagraphAdjust_BLOCK:
        case css::style::ParagraphAdjust_STRETCH:
            return u"justify"_ustr;
        case css::style::ParagraphAdjust_CENTER:
            return u"center"_ustr;
        default:
            assert(false && "Unhandled ParagraphAdjust value");
            return u""_ustr;
    }
}
}

OUString AccessibleTextAttributeHelper::ConvertUnoToIAccessible2TextAttributes(
    const css::uno::Sequence<css::beans::PropertyValue>& rUnoAttributes,
    IA2AttributeType eAttributeType)
{
    OUString aRet;
    for (css::beans::PropertyValue const& prop : rUnoAttributes)
    {
        OUString sAttribute;
        OUString sValue;

        if (eAttributeType & IA2AttributeType::TextAttributes)
        {
            if (prop.Name == "CharBackColor")
            {
                sAttribute = "background-color";
                sValue = lcl_ConvertColor(
                    Color(ColorTransparency, *o3tl::doAccess<sal_Int32>(prop.Value)));
            }
            else if (prop.Name == "CharColor")
            {
                sAttribute = "color";
                sValue = lcl_ConvertColor(
                    Color(ColorTransparency, *o3tl::doAccess<sal_Int32>(prop.Value)));
            }
            else if (prop.Name == "CharEscapement")
            {
                sAttribute = "text-position";
                const sal_Int16 nEscapement = *o3tl::doAccess<sal_Int16>(prop.Value);
                sValue = lcl_ConvertCharEscapement(nEscapement);
            }
            else if (prop.Name == "CharFontName")
            {
                sAttribute = "font-family";
                sValue = *o3tl::doAccess<OUString>(prop.Value);
            }
            else if (prop.Name == "CharHeight")
            {
                sAttribute = "font-size";
                sValue = OUString::number(*o3tl::doAccess<double>(prop.Value)) + "pt";
            }
            else if (prop.Name == "CharPosture")
            {
                sAttribute = "font-style";
                const css::awt::FontSlant eFontSlant
                    = *o3tl::doAccess<css::awt::FontSlant>(prop.Value);
                sValue = lcl_ConvertFontSlant(eFontSlant);
            }
            else if (prop.Name == "CharStrikeout")
            {
                const sal_Int16 nStrikeout = *o3tl::doAccess<sal_Int16>(prop.Value);
                aRet += lcl_ConverCharStrikeout(nStrikeout);
            }
            else if (prop.Name == "CharUnderline")
            {
                OUString sUnderlineStyle;
                OUString sUnderlineType;
                OUString sUnderlineWidth;
                const sal_Int16 nUnderline = *o3tl::doAccess<sal_Int16>(prop.Value);
                lcl_ConvertFontUnderline(nUnderline, sUnderlineStyle, sUnderlineType,
                                         sUnderlineWidth);

                // leave 'sAttribute' and 'sName' empty, set all attributes here
                if (!sUnderlineStyle.isEmpty())
                    aRet += u"text-underline-style:" + sUnderlineStyle + ";";
                if (!sUnderlineType.isEmpty())
                    aRet += u"text-underline-type:" + sUnderlineType + ";";
                if (!sUnderlineWidth.isEmpty())
                    aRet += u"text-underline-width:" + sUnderlineWidth + ";";
            }
            else if (prop.Name == "CharWeight")
            {
                sAttribute = "font-weight";
                sValue = lcl_convertFontWeight(*o3tl::doAccess<double>(prop.Value));
            }
        }

        // so far, "ParaAdjust" is the only UNO text attribute that
        // maps to an object attribute for IAccessible2 ("text-align")
        if (sAttribute.isEmpty() && (eAttributeType & IA2AttributeType::ObjectAttributes)
            && prop.Name == "ParaAdjust")
        {
            sAttribute = "text-align";
            const css::style::ParagraphAdjust eParaAdjust
                = static_cast<css::style::ParagraphAdjust>(*o3tl::doAccess<sal_Int16>(prop.Value));
            sValue = lcl_ConvertParagraphAdjust(eParaAdjust);
        }

        if (!sAttribute.isEmpty() && !sValue.isEmpty())
            aRet += sAttribute + ":" + sValue + ";";
    }

    return aRet;
}

OUString AccessibleTextAttributeHelper::GetIAccessible2TextAttributes(
    css::uno::Reference<css::accessibility::XAccessibleText> xText, IA2AttributeType eAttributeType,
    sal_Int32 nOffset, sal_Int32& rStartOffset, sal_Int32& rEndOffset)
{
    assert(xText.is());

    const css::uno::Sequence<css::beans::PropertyValue> attribs
        = xText->getCharacterAttributes(nOffset, css::uno::Sequence<OUString>());
    OUString sAttributes = ConvertUnoToIAccessible2TextAttributes(attribs, eAttributeType);

    css::accessibility::TextSegment aAttributeRun
        = xText->getTextAtIndex(nOffset, css::accessibility::AccessibleTextType::ATTRIBUTE_RUN);
    rStartOffset = aAttributeRun.SegmentStart;
    rEndOffset = aAttributeRun.SegmentEnd;

    // report spelling error as "invalid:spelling;" IA2 text attribute and
    // adapt start/end index as necessary
    css::uno::Reference<css::accessibility::XAccessibleTextMarkup> xTextMarkup(xText,
                                                                               css::uno::UNO_QUERY);
    if ((eAttributeType & IA2AttributeType::TextAttributes) && xTextMarkup.is())
    {
        bool bInvalidSpelling = false;
        const sal_Int32 nMarkupCount(
            xTextMarkup->getTextMarkupCount(css::text::TextMarkupType::SPELLCHECK));
        for (sal_Int32 nMarkupIndex = 0; nMarkupIndex < nMarkupCount; ++nMarkupIndex)
        {
            const css::accessibility::TextSegment aTextSegment
                = xTextMarkup->getTextMarkup(nMarkupIndex, css::text::TextMarkupType::SPELLCHECK);
            const sal_Int32 nStartOffsetTextMarkup = aTextSegment.SegmentStart;
            const sal_Int32 nEndOffsetTextMarkup = aTextSegment.SegmentEnd;
            if (nStartOffsetTextMarkup <= nOffset)
            {
                if (nOffset < nEndOffsetTextMarkup)
                {
                    // offset is inside invalid spelling
                    rStartOffset = ::std::max(rStartOffset, nStartOffsetTextMarkup);
                    rEndOffset = ::std::min(rEndOffset, nEndOffsetTextMarkup);
                    bInvalidSpelling = true;
                    break;
                }
                else
                {
                    rStartOffset = ::std::max(rStartOffset, nEndOffsetTextMarkup);
                }
            }
            else
            {
                rEndOffset = ::std::min(rEndOffset, nStartOffsetTextMarkup);
            }
        }

        if (bInvalidSpelling)
            sAttributes += u"invalid:spelling;"_ustr;
    }

    return sAttributes;
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */