summaryrefslogtreecommitdiff
path: root/sw/source/core/text/guess.cxx
blob: 6084d94ed6fbc5fef8d0c0083de3b3b90f669b79 (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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
/*************************************************************************
 *
 *  $RCSfile: guess.cxx,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: ama $ $Date: 2000-10-26 08:23:11 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifdef PRECOMPILED
#include "core_pch.hxx"
#endif

#pragma hdrstop

#include <ctype.h>

#ifndef _ERRHDL_HXX
#include <errhdl.hxx>   // ASSERTs
#endif
#ifndef _TXTCFG_HXX
#include <txtcfg.hxx>
#endif
#ifndef _GUESS_HXX
#include <guess.hxx>
#endif
#ifndef _INFTXT_HXX
#include <inftxt.hxx>   // SwTxtSizeInfo, SwTxtFormatInfo
#endif
#ifndef _SWFONT_HXX
#include <swfont.hxx>
#endif
#ifndef _BREAKIT_HXX
#include <breakit.hxx>
#endif
#ifndef _VIEWSH_HXX
#include <viewsh.hxx>
#endif

#ifndef _COM_SUN_STAR_TEXT_BREAKTYPE_HPP_
#include <com/sun/star/text/BreakType.hpp>
#endif

using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::text;
using namespace ::com::sun::star::linguistic;

inline sal_Bool IsDelim( const xub_Unicode cCh )
{
    return ' ' == cCh;
}

/*************************************************************************
 *                      SwTxtGuess::IsWordEnd
 *************************************************************************/


sal_Bool SwTxtGuess::IsWordEnd( const SwTxtSizeInfo &rInf, const xub_StrLen nPos )
{
    const xub_StrLen nEnd = rInf.GetIdx() + rInf.GetLen();

    ASSERT( nPos <= nEnd, "WordEnd hinter Text?" );

    // Das letzte Zeichen gilt immer als Wortende
    if ( nPos >= nEnd )
        return sal_True;

    const XubString& rTxt = rInf.GetTxt();
    xub_Unicode aChr = rTxt.GetChar( nPos );
    xub_Unicode aChr1 = rTxt.GetChar( nPos + 1 );

    // Bindestriche sind potentielle Wortenden mit folgenden Ausnahmen:
    // es folgt ein weiterer Bindestrich
    // es folgt Textmasse, vor dem Bindestrich sind nur Bindestriche und
    // davor ein Blank ...
    if( '-' == aChr )
    {
        if ( IsDelim( aChr1 ) )
            return sal_True;
        if ( !nPos || '-' == aChr1 )
            return sal_False;
        for ( xub_StrLen nCnt = nPos; nCnt && '-' == aChr; )
            aChr = rTxt.GetChar( --nCnt );
        return ( !IsDelim( aChr ) && '-' != aChr );
    }

    // sal_True, wenn nPos kein Blank ist, aber der darauffolgende
    if( !IsDelim( aChr ) && IsDelim( aChr1 ) )
        return sal_True;
    else
        return sal_False;
}


/*************************************************************************
 *                      _GetFwdWordEnd()
 *
 * Es wird die letzte Position im Wort zurueckgeliefert:
 * Aus "123 456" wird "123" nicht "123 " !!!
 * Sonderfaelle bei "-"
 *************************************************************************/

xub_StrLen _GetFwdWordEnd( const XubString& rTxt, xub_StrLen nFound,
                           const xub_StrLen nMaxPos )
{
    if( nFound == nMaxPos )
        return nMaxPos;

    // Suche von links nach rechts
    // Die Spaces vor einem Wort gehoeren dazu:
    for( ++nFound; nFound < nMaxPos && IsDelim( rTxt.GetChar( nFound ) ); ++nFound )
        ;

    if ( nFound == nMaxPos )
        return nMaxPos;

    // Sonderfall: Bindestrich
    if ( '-' == rTxt.GetChar( nFound ) )
    {
        // Mal gucken, was vor den Bindestrichen los ist
        for ( ; nFound && '-' == rTxt.GetChar( nFound ); --nFound )
            ;
        // Ist vor uns ein Wortteil oder Nichts?
        const sal_Bool bPartOfWord = nFound && !IsDelim( rTxt.GetChar( nFound ) );
        // Und wieder hinter die Bindestriche
        for ( ++nFound; nFound && '-' == rTxt.GetChar( nFound ); ++nFound )
            ;
        if ( nFound > nMaxPos )
            return nMaxPos;
        if ( bPartOfWord || IsDelim( rTxt.GetChar( nFound ) ) )
            return nFound - 1;
    }

    // Beim naechsten Space ist Schluss
    for( ; nFound < nMaxPos; ++nFound )
    {
         if( IsDelim( rTxt.GetChar( nFound ) ) )
            return nFound - 1;
         if( '-' == rTxt.GetChar( nFound ) )
         {
            while ( '-' == rTxt.GetChar( nFound ) )
                ++nFound;
            if ( nFound > nMaxPos )
                return nMaxPos;
            else
                return nFound - 1;
        }
    }
    return nFound;
}

/*************************************************************************
 *                      _GetBwdWordEnd()
 *
 * Es wird die letzte Position im Wort zurueckgeliefert:
 * Aus "123 456" wird "123" nicht "123 " !!!
 * Sonderfaelle bei "-"
 *************************************************************************/

xub_StrLen _GetBwdWordEnd( const XubString& rTxt, xub_StrLen nFound,
                           const xub_StrLen nMin )
{
    const xub_StrLen nStart = nFound;
    if( !nFound )
        return 0;

    // Suche von rechts nach links
    // Bloede Striche
    for( ; nFound && '-' == rTxt.GetChar( nFound ); --nFound )
        ;

    // Bis zum Anfang der Textmasse.
    for( ; nFound && !IsDelim( rTxt.GetChar( nFound ) ); --nFound )
    {
        if( '-' == rTxt.GetChar(nFound) && !ispunct( rTxt.GetChar(nFound+1) ) )
            break;
    }

    if ( '-' == rTxt.GetChar( nFound ) )
    {
        xub_StrLen nOldFound = nFound;
        // Mal gucken, was vor den Bindestrichen los ist
        for ( ; nFound && '-' == rTxt.GetChar( nFound ); --nFound )
            ;
        // Ist vor uns ein Wortteil?
        if( nFound && !IsDelim( rTxt.GetChar( nFound ) ) )
            return nOldFound;
    }

    // Die Spaces hinter einem Wort gehoeren nicht dazu:
    for( ; nFound > nMin; --nFound )
    {
        if( !IsDelim( rTxt.GetChar( nFound ) ) )
            break;
    }
    if( nMin == nFound )
    {
        if( IsDelim( rTxt.GetChar( nFound ) ) )
        {
            while( ++nFound < nStart && IsDelim( rTxt.GetChar( nFound ) ) )
                ;
            --nFound;
        }
        else if( nMin )
            --nFound;
    }

    return nFound;
}

/*************************************************************************
 *                      SwTxtGuess::GetWordEnd
 *************************************************************************/

// Liefert die Wortgrenze je nach Suchrichtung zurueck.
// Wortdelimitter sind (nach dem letzten Projekt-Parteitag) nur
// noch Blanks.
// Fuehrende Blanks gehoeren zum Wort, aus "XXX   YYY" wird
// "XXX" und "   YYY".

xub_StrLen SwTxtGuess::GetWordEnd( const SwTxtFormatInfo &rInf,
                                const xub_StrLen nPos, const sal_Bool bFwd ) const
{
    const xub_StrLen nMaxPos = rInf.GetIdx() + rInf.GetLen() - 1;
    const xub_StrLen nIdx = nPos < nMaxPos ? nPos : nMaxPos;
    return  bFwd ? _GetFwdWordEnd( rInf.GetTxt(), nIdx, nMaxPos )
                 : _GetBwdWordEnd( rInf.GetTxt(), nIdx, rInf.GetLineStart() );
}

/*************************************************************************
 *                      SwTxtGuess::Guess
 *
 * Nach Guess muessen folgende Verhaeltnisse vorliegen:
 * Bsp: "XXX   YYY", Umbruch beim 2.Space
 * GetLeftPos() liefert das Ende des noch passenden Wortes: "XXX", 3
 * GetRightPos() liefert den Beginn des nicht mehr passenden Wortes: " YYY"
 * Wenn das Wort ganz passte, dann ist GetLeftPos() == GetRightPos().
 * Etwas Verwirrung stiftet der Unterschied zwischen Position und Laenge:
 * GetWord() arbeitet ausschliesslich mit String-Positionen, waehrend
 * die Breiten per GetTxtSize() und damit ueber Laengen ermittelt werden.
 * Die Laenge ist (nach Abzug des Offsets) immer genau um 1 groesser
 * als die Position.
 * Liefert zurueck, ob es noch passte...
 *************************************************************************/

sal_Bool SwTxtGuess::Guess( const SwTxtFormatInfo &rInf, const KSHORT nPorHeight )
{
    nLeftPos = nRightPos = rInf.GetIdx();
    // Leere Strings sind immer 0
    if( !rInf.GetLen() || !rInf.GetTxt().Len() )
    {
        nHeight = rInf.GetTxtHeight();
        return sal_False;
    }
    ASSERT( rInf.GetIdx() < rInf.GetTxt().Len(),
            "+SwTxtGuess::Guess: invalid SwTxtFormatInfo" );

    nHeight = nPorHeight;

    KSHORT nLineWidth = rInf.Width() - rInf.X();
    const xub_StrLen nMaxLen = Min( xub_StrLen(rInf.GetTxt().Len() - rInf.GetIdx()),
                                rInf.GetLen() );
    // Sonderfall: Zeichen breiter als Zeile
    if( !nMaxLen || !nLineWidth )
    {
        nHeight = rInf.GetTxtHeight();
        return sal_False;
    }

    if( !nHeight )
    {
        ASSERT( nHeight, "+SwTxtGuess::Guess: no height" );
        nHeight = rInf.GetTxtHeight();
        if( !nHeight )
            nHeight = 1;
    }

    KSHORT nItalic = 0;
    if( ITALIC_NONE != rInf.GetFont()->GetItalic() && !rInf.NotEOL() )
    {
#ifdef DEBUG
        static MSHORT nDiv = 12;
        nItalic = nHeight / nDiv;
#else
#ifdef MAC
        nItalic = nHeight / 4;
#else
        nItalic = nHeight / 12;
#endif
#endif
        if( nItalic >= nLineWidth )
        {
            nLeftWidth = nRightWidth = nItalic;
            nLeftPos = nRightPos = rInf.GetIdx();
            return sal_False;
        }
        else
            nLineWidth -= nItalic;
    }

    // Kein GetTextBreak, wenn vermutlich alles passt
    if ( long ( nLineWidth ) * 2 > long ( nMaxLen ) * nHeight )
    {
        nLeftWidth = rInf.GetTxtSize( rInf.GetIdx(), nMaxLen ).Width();

        if ( nLeftWidth <= nLineWidth )
        {
            // Die Vermutung hat sich bewahrheitet
            nLeftPos = nRightPos = rInf.GetIdx() + nMaxLen - 1;
            nHeight = rInf.GetTxtHeight();
            if( nItalic && ( nLeftPos + 1 ) >= rInf.GetTxt().Len() )
                nLeftWidth += nItalic;
            nRightWidth = nLeftWidth;
            return sal_True;
        }
#ifdef DEBUG
        nRightWidth = nLeftWidth; // nur zum Breakpoint setzen,
                                  // Vermutung schlug fehl, teuer!
#endif
    }

    nHeight = rInf.GetTxtHeight();

    sal_Bool bHyph = rInf.IsHyphenate() && !rInf.IsHyphForbud();
    xub_StrLen nHyphPos = 0;

    if( bHyph )
        nRightPos = rInf.GetTxtBreak( nLineWidth, rInf.GetIdx(), nMaxLen,
                                       nHyphPos );
    else
        nRightPos = rInf.GetTxtBreak( nLineWidth, rInf.GetIdx(), nMaxLen );

    if( nRightPos > rInf.GetIdx() + nMaxLen )
    {
        // passt noch auf die Zeile
        nLeftPos = nRightPos = rInf.GetIdx() + nMaxLen - 1;
        if( bHyph )
            nHyphPos = nLeftPos;
        nLeftWidth = nRightWidth =
            rInf.GetTxtSize( rInf.GetIdx(), nMaxLen ).Width();
        // Der folgende Vergleich sollte eigenlich immer sal_True ergeben, sonst
        // hat es wohl bei GetTxtBreak einen Pixel-Rundungsfehler gegeben...
        if ( nLeftWidth <= nLineWidth )
        {
            if( nItalic && ( nLeftPos + 1 ) >= rInf.GetTxt().Len() )
            {
                nLeftWidth += nItalic;
                nRightWidth = nLeftWidth;
            }
            return sal_True;
        }
    }

    if( IsDelim( rInf.GetChar( nRightPos ) ) )
    {
        nLeftPos = nRightPos;
        while( nRightPos && IsDelim( rInf.GetChar( --nRightPos ) ) )
            --nLeftPos;
    }
    else
    {
        nLeftPos = nRightPos;
        if( pBreakIt->xBreak.is() )
        {
            LineBreakHyphenationOptions aHyphOpt;
            Reference< XHyphenator >  xHyph;
            if( bHyph )
            {
                xHyph = ::GetHyphenator();
                aHyphOpt = LineBreakHyphenationOptions( xHyph, nHyphPos );
            }
            LineBreakResults aResult = pBreakIt->xBreak->getLineBreak( rInf.GetTxt(),
                nRightPos, pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ),
                rInf.GetIdx(), aHyphOpt, LineBreakUserOptions() );
            nLeftPos = aResult.breakIndex;
            if( nLeftPos == STRING_LEN )
                nLeftPos = 0;
            bHyph = aResult.breakType == BreakType::HYPHENATION;
            if( bHyph )
                xHyphWord = aResult.rHyphenatedWord;
            else
                xHyphWord = NULL;

            if( nLeftPos )
            {
                xub_StrLen nX = nLeftPos;
                while( nX && IsDelim( rInf.GetChar( --nX ) ) )
                    nLeftPos = nX;
            }
        }
    }

    if ( nLeftPos < rInf.GetIdx() )
        nLeftPos = rInf.GetIdx();

    if( !SwTxtGuess::IsWordEnd( rInf, nRightPos ) )
        nRightPos = GetNextEnd( rInf, nRightPos );

    nLeftWidth =
    rInf.GetTxtSize( rInf.GetIdx(), nLeftPos - rInf.GetIdx() ).Width();

    bHyph = bHyph && ( nHyphPos > nLeftPos );

    // Sicher ist sicher, robust gg. Rundungfehler in GetTxtBreak ...
    if ( nLeftWidth > nLineWidth )
    {
        rInf.GetTxtSize( rInf.GetIdx(), nLeftPos - rInf.GetIdx() + 1 ).Width();
        bHyph = sal_False;
        nLeftPos = GetPrevEnd( rInf, nLeftPos );
        if ( nLeftPos < rInf.GetIdx() )
            nLeftPos = rInf.GetIdx();
        nRightPos = GetNextEnd( rInf, nLeftPos );
        nLeftWidth =
            rInf.GetTxtSize( rInf.GetIdx(), nLeftPos - rInf.GetIdx() + 1 ).Width();
    }
    nLeftWidth += nItalic;
    nRightWidth = nLeftWidth;
    return sal_False;
}