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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* 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 <string.h>
#include <vcl/svapp.hxx>
#include <vcl/settings.hxx>
#include <vcl/mnemonic.hxx>
#include <vcl/unohelp.hxx>
#include <com/sun/star/i18n/XCharacterClassification.hpp>
#include <i18nlangtag/mslangid.hxx>
using namespace ::com::sun::star;
// =======================================================================
MnemonicGenerator::MnemonicGenerator()
{
memset( maMnemonics, 1, sizeof( maMnemonics ) );
}
// -----------------------------------------------------------------------
sal_uInt16 MnemonicGenerator::ImplGetMnemonicIndex( sal_Unicode c )
{
static sal_uInt16 const aImplMnemonicRangeTab[MNEMONIC_RANGES*2] =
{
MNEMONIC_RANGE_1_START, MNEMONIC_RANGE_1_END,
MNEMONIC_RANGE_2_START, MNEMONIC_RANGE_2_END,
MNEMONIC_RANGE_3_START, MNEMONIC_RANGE_3_END,
MNEMONIC_RANGE_4_START, MNEMONIC_RANGE_4_END
};
sal_uInt16 nMnemonicIndex = 0;
for ( sal_uInt16 i = 0; i < MNEMONIC_RANGES; i++ )
{
if ( (c >= aImplMnemonicRangeTab[i*2]) &&
(c <= aImplMnemonicRangeTab[i*2+1]) )
return nMnemonicIndex+c-aImplMnemonicRangeTab[i*2];
nMnemonicIndex += aImplMnemonicRangeTab[i*2+1]-aImplMnemonicRangeTab[i*2];
}
return MNEMONIC_INDEX_NOTFOUND;
}
// -----------------------------------------------------------------------
sal_Unicode MnemonicGenerator::ImplFindMnemonic( const OUString& rKey )
{
sal_Int32 nIndex = 0;
while ( (nIndex = rKey.indexOf( MNEMONIC_CHAR, nIndex )) != -1 )
{
sal_Unicode cMnemonic = rKey[ nIndex+1 ];
if ( cMnemonic != MNEMONIC_CHAR )
return cMnemonic;
nIndex += 2;
}
return 0;
}
// -----------------------------------------------------------------------
void MnemonicGenerator::RegisterMnemonic( const OUString& rKey )
{
const ::com::sun::star::lang::Locale& rLocale = Application::GetSettings().GetUILanguageTag().getLocale();
uno::Reference < i18n::XCharacterClassification > xCharClass = GetCharClass();
// Don't crash even when we don't have access to i18n service
if ( !xCharClass.is() )
return;
OUString aKey = xCharClass->toUpper( rKey, 0, rKey.getLength(), rLocale );
// If we find a Mnemonic, set the flag. In other case count the
// characters, because we need this to set most as possible
// Mnemonics
sal_Unicode cMnemonic = ImplFindMnemonic( aKey );
if ( cMnemonic )
{
sal_uInt16 nMnemonicIndex = ImplGetMnemonicIndex( cMnemonic );
if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
maMnemonics[nMnemonicIndex] = 0;
}
else
{
sal_Int32 nIndex = 0;
sal_Int32 nLen = aKey.getLength();
while ( nIndex < nLen )
{
sal_Unicode c = aKey[ nIndex ];
sal_uInt16 nMnemonicIndex = ImplGetMnemonicIndex( c );
if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
{
if ( maMnemonics[nMnemonicIndex] && (maMnemonics[nMnemonicIndex] < 0xFF) )
maMnemonics[nMnemonicIndex]++;
}
nIndex++;
}
}
}
// -----------------------------------------------------------------------
OUString MnemonicGenerator::CreateMnemonic( const OUString& _rKey )
{
if ( _rKey.isEmpty() || ImplFindMnemonic( _rKey ) )
return _rKey;
const ::com::sun::star::lang::Locale& rLocale = Application::GetSettings().GetUILanguageTag().getLocale();
uno::Reference < i18n::XCharacterClassification > xCharClass = GetCharClass();
// Don't crash even when we don't have access to i18n service
if ( !xCharClass.is() )
return _rKey;
OUString aKey = xCharClass->toUpper( _rKey, 0, _rKey.getLength(), rLocale );
sal_Bool bChanged = sal_False;
sal_Int32 nLen = aKey.getLength();
bool bCJK = MsLangId::isCJK(Application::GetSettings().GetUILanguageTag().getLanguageType());
// #107889# in CJK versions ALL strings (even those that contain latin characters)
// will get mnemonics in the form: xyz (M)
// thus steps 1) and 2) are skipped for CJK locales
// #110720#, avoid CJK-style mnemonics for latin-only strings that do not contain useful mnemonic chars
if( bCJK )
{
bool bLatinOnly = true;
bool bMnemonicIndexFound = false;
sal_Unicode c;
sal_Int32 nIndex;
for( nIndex=0; nIndex < nLen; nIndex++ )
{
c = aKey[ nIndex ];
if ( ((c >= 0x3000) && (c <= 0xD7FF)) || // cjk
((c >= 0xFF61) && (c <= 0xFFDC)) ) // halfwidth forms
{
bLatinOnly = false;
break;
}
if( ImplGetMnemonicIndex( c ) != MNEMONIC_INDEX_NOTFOUND )
bMnemonicIndexFound = true;
}
if( bLatinOnly && !bMnemonicIndexFound )
return _rKey;
}
OUString rKey(_rKey);
int nCJK = 0;
sal_uInt16 nMnemonicIndex;
sal_Unicode c;
sal_Int32 nIndex = 0;
if( !bCJK )
{
// 1) first try the first character of a word
do
{
c = aKey[ nIndex ];
if ( nCJK != 2 )
{
if ( ((c >= 0x3000) && (c <= 0xD7FF)) || // cjk
((c >= 0xFF61) && (c <= 0xFFDC)) ) // halfwidth forms
nCJK = 1;
else if ( ((c >= 0x0030) && (c <= 0x0039)) || // digits
((c >= 0x0041) && (c <= 0x005A)) || // latin capitals
((c >= 0x0061) && (c <= 0x007A)) || // latin small
((c >= 0x0370) && (c <= 0x037F)) || // greek numeral signs
((c >= 0x0400) && (c <= 0x04FF)) ) // cyrillic
nCJK = 2;
}
nMnemonicIndex = ImplGetMnemonicIndex( c );
if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
{
if ( maMnemonics[nMnemonicIndex] )
{
maMnemonics[nMnemonicIndex] = 0;
rKey = rKey.replaceAt( nIndex, 0, OUString(MNEMONIC_CHAR) );
bChanged = sal_True;
break;
}
}
// Search for next word
nIndex++;
while ( nIndex < nLen )
{
c = aKey[ nIndex ];
if ( c == ' ' )
break;
nIndex++;
}
nIndex++;
}
while ( nIndex < nLen );
// 2) search for a unique/uncommon character
if ( !bChanged )
{
sal_uInt16 nBestCount = 0xFFFF;
sal_uInt16 nBestMnemonicIndex = 0;
sal_Int32 nBestIndex = 0;
nIndex = 0;
do
{
c = aKey[ nIndex ];
nMnemonicIndex = ImplGetMnemonicIndex( c );
if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
{
if ( maMnemonics[nMnemonicIndex] )
{
if ( maMnemonics[nMnemonicIndex] < nBestCount )
{
nBestCount = maMnemonics[nMnemonicIndex];
nBestIndex = nIndex;
nBestMnemonicIndex = nMnemonicIndex;
if ( nBestCount == 2 )
break;
}
}
}
nIndex++;
}
while ( nIndex < nLen );
if ( nBestCount != 0xFFFF )
{
maMnemonics[nBestMnemonicIndex] = 0;
rKey = rKey.replaceAt( nBestIndex, 0, OUString(MNEMONIC_CHAR) );
bChanged = sal_True;
}
}
}
else
nCJK = 1;
// 3) Add English Mnemonic for CJK Text
if ( !bChanged && (nCJK == 1) && !rKey.isEmpty() )
{
// Append Ascii Mnemonic
for ( c = MNEMONIC_RANGE_2_START; c <= MNEMONIC_RANGE_2_END; c++ )
{
nMnemonicIndex = ImplGetMnemonicIndex( c );
if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
{
if ( maMnemonics[nMnemonicIndex] )
{
maMnemonics[nMnemonicIndex] = 0;
OUString aStr = OUStringBuffer().
append('(').append(MNEMONIC_CHAR).append(c).
append(')').makeStringAndClear();
nIndex = rKey.getLength();
if( nIndex >= 2 )
{
if ( ( rKey[nIndex-2] == '>' && rKey[nIndex-1] == '>' ) ||
( rKey[nIndex-2] == 0xFF1E && rKey[nIndex-1] == 0xFF1E ) )
nIndex -= 2;
}
if( nIndex >= 3 )
{
if ( ( rKey[nIndex-3] == '.' && rKey[nIndex-2] == '.' && rKey[nIndex-1] == '.' ) ||
( rKey[nIndex-3] == 0xFF0E && rKey[nIndex-2] == 0xFF0E && rKey[nIndex-1] == 0xFF0E ) )
nIndex -= 3;
}
if( nIndex >= 1)
{
sal_Unicode cLastChar = rKey[ nIndex-1 ];
if ( (cLastChar == ':') || (cLastChar == 0xFF1A) ||
(cLastChar == '.') || (cLastChar == 0xFF0E) ||
(cLastChar == '?') || (cLastChar == 0xFF1F) ||
(cLastChar == ' ') )
nIndex--;
}
rKey = rKey.replaceAt( nIndex, 0, aStr );
bChanged = sal_True;
break;
}
}
}
}
// #i87415# Duplicates mnemonics are bad for consistent keyboard accessibility
// It's probably better to not have mnemonics for some widgets, than to have ambiguous ones.
// if( ! bChanged )
// {
// /*
// * #97809# if all else fails use the first character of a word
// * anyway and live with duplicate mnemonics
// */
// nIndex = 0;
// do
// {
// c = aKey.GetChar( nIndex );
//
// nMnemonicIndex = ImplGetMnemonicIndex( c );
// if ( nMnemonicIndex != MNEMONIC_INDEX_NOTFOUND )
// {
// maMnemonics[nMnemonicIndex] = 0;
// rKey.Insert( MNEMONIC_CHAR, nIndex );
// bChanged = sal_True;
// break;
// }
//
// // Search for next word
// do
// {
// nIndex++;
// c = aKey.GetChar( nIndex );
// if ( c == ' ' )
// break;
// }
// while ( nIndex < nLen );
// nIndex++;
// }
// while ( nIndex < nLen );
// }
return rKey;
}
// -----------------------------------------------------------------------
uno::Reference< i18n::XCharacterClassification > MnemonicGenerator::GetCharClass()
{
if ( !mxCharClass.is() )
mxCharClass = vcl::unohelper::CreateCharacterClassification();
return mxCharClass;
}
// -----------------------------------------------------------------------
OUString MnemonicGenerator::EraseAllMnemonicChars( const OUString& rStr )
{
OUString aStr = rStr;
sal_Int32 nLen = aStr.getLength();
sal_Int32 i = 0;
while ( i < nLen )
{
if ( aStr[ i ] == '~' )
{
// check for CJK-style mnemonic
if( i > 0 && (i+2) < nLen )
{
sal_Unicode c = aStr[i+1];
if( aStr[ i-1 ] == '(' &&
aStr[ i+2 ] == ')' &&
c >= MNEMONIC_RANGE_2_START && c <= MNEMONIC_RANGE_2_END )
{
aStr = aStr.replaceAt( i-1, 4, "" );
nLen -= 4;
i--;
continue;
}
}
// remove standard mnemonics
aStr = aStr.replaceAt( i, 1, "" );
nLen--;
}
else
i++;
}
return aStr;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
