summaryrefslogtreecommitdiff
path: root/sw/source/core/text/txthyph.cxx
blob: a8f410f873a59ee4422c6391c91b154237b12212 (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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
/*************************************************************************
 *
 *  $RCSfile: txthyph.cxx,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: tl $ $Date: 2000-10-27 12:12:13 $
 *
 *  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

#ifndef _HINTIDS_HXX
#include <hintids.hxx>
#endif

#ifndef _UNO_LINGU_HXX
#include <svx/unolingu.hxx>
#endif
#ifndef _COM_SUN_STAR_TEXT_WORDTYPE_HPP_
#include <com/sun/star/text/WordType.hpp>
#endif

#ifndef _VIEWOPT_HXX
#include <viewopt.hxx>  // SwViewOptions
#endif
#ifndef _VIEWSH_HXX
#include <viewsh.hxx>
#endif
#ifndef _ERRHDL_HXX
#include <errhdl.hxx>
#endif
#ifndef _TXTCFG_HXX
#include <txtcfg.hxx>
#endif
#ifndef _PORHYPH_HXX
#include <porhyph.hxx>  //
#endif
#ifndef _INFTXT_HXX
#include <inftxt.hxx>
#endif
#ifndef _TXTFRM_HXX
#include <txtfrm.hxx>
#endif
#ifndef _ITRFORM2_HXX
#include <itrform2.hxx> //
#endif
#ifndef _GUESS_HXX
#include <guess.hxx>    //
#endif
#ifndef _SPLARGS_HXX
#include <splargs.hxx>  // SwInterHyphInfo
#endif
#ifndef _PORRST_HXX
#include <porrst.hxx>   // SwKernPortion
#endif

#ifndef PRODUCT
extern const sal_Char *GetLangName( const MSHORT nLang );
#endif

using namespace ::rtl;
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::linguistic2;
using namespace ::com::sun::star::text;

/*************************************************************************
 *                      SwTxtFormatInfo::HyphWord()
 *************************************************************************/

Reference< XHyphenatedWord >  SwTxtFormatInfo::HyphWord(
                                const XubString &rTxt, const MSHORT nMinTrail )
{
    if( rTxt.Len() < 4 || pFnt->IsSymbol(pVsh) )
        return 0;
    ASSERT( IsHyphenate(), "SwTxtFormatter::HyphWord: why?" );
    Reference< XHyphenator >  xHyph = ::GetHyphenator();
    Reference< XHyphenatedWord > xHyphWord;

    if( xHyph.is() )
        xHyphWord = xHyph->hyphenate( OUString(rTxt),
                            pBreakIt->GetLocale( pFnt->GetLanguage() ),
                            rTxt.Len() - nMinTrail,
                            Sequence< PropertyValue >() );
    return xHyphWord;

}

/*************************************************************************
 *                      SwTxtFrm::Hyphenate
 *
 * Wir formatieren eine Zeile fuer die interaktive Trennung
 *************************************************************************/

sal_Bool SwTxtFrm::Hyphenate( SwInterHyphInfo &rHyphInf )
{
    if( !pBreakIt->xBreak.is() )
        return sal_False;;
    // Wir machen den Laden erstmal dicht:
    ASSERT( !IsLocked(), "SwTxtFrm::Hyphenate: this is locked" );
    // 4935: Der ::com::sun::star::frame::Frame muss eine gueltige SSize haben!
    Calc();
    GetFormatted();

    sal_Bool bRet = sal_False;
    if( !IsEmpty() )
    {
        // Wir muessen die Trennung immer einschalten.
        // Keine Angst, der SwTxtIter sichert im Hyphenate die alte Zeile.
        SwTxtFrmLocker aLock( this );
        SwTxtFormatInfo aInf( this, sal_True );     // sal_True fuer interactive hyph!
        SwTxtFormatter aLine( this, &aInf );
        aLine.CharToLine( rHyphInf.nStart );
        // Wenn wir innerhalb des ersten Wortes einer Zeile stehen, so koennte
        // dieses in der vorherigen getrennt werden, deshalb gehen wir ein Zeile
        // zurueck.
        if( aLine.Prev() )
        {
            SwLinePortion *pPor = aLine.GetCurr()->GetFirstPortion();
            while( pPor->GetPortion() )
                pPor = pPor->GetPortion();
            if( pPor->GetWhichPor() == POR_SOFTHYPH ||
                pPor->GetWhichPor() == POR_SOFTHYPHSTR )
                aLine.Next();
        }

        const xub_StrLen nEnd = rHyphInf.GetEnd();
        while( !bRet && aLine.GetStart() < nEnd )
        {
            DBG_LOOP;
            bRet = aLine.Hyphenate( rHyphInf );
            if( !aLine.Next() )
                break;
        }
    }
    return bRet;
}

/*************************************************************************
 *                      SwTxtFormatter::Hyphenate
 *
 * Wir formatieren eine Zeile fuer die interaktive Trennung
 *************************************************************************/
// Wir koennen davon ausgehen, dass bereits formatiert wurde.
// Fuer die CeBIT'93 gehen wir den einfachen, sicheren Weg:
// Die Zeile wird einfach neu formatiert, der Hyphenator wird dann
// so vorbereitet, wie ihn die UI erwartet.
// Hier stehen natuerlich enorme Optimierungsmoeglichkeiten offen.

void SetParaPortion( SwTxtInfo *pInf, SwParaPortion *pRoot )
{
    ASSERT( pRoot, "SetParaPortion: no root anymore" );
    pInf->pPara = pRoot;
}

sal_Bool SwTxtFormatter::Hyphenate( SwInterHyphInfo &rHyphInf )
{
    SwTxtFormatInfo &rInf = GetInfo();
    sal_Bool bRet = sal_False;

    // In der letzten Zeile gibt es nie etwas zu trennen.
    // Es sei denn, es befindet sich eine FlyPortion darin,
    // oder es ist die letzte Zeile des Masters
    if( !GetNext() && !rInf.GetTxtFly()->IsOn() && !pFrm->GetFollow() )
        return bRet;

    xub_StrLen nWrdStart = nStart;

    // Wir muessen die alte Zeile erhalten. Ein Beispiel:
    // Das Attribut fuer Trennung wurde nicht gesetzt,
    // in SwTxtFrm::Hyphenate wird es jedoch immer gesetzt,
    // weil wir Trennpositionen im Hyphenator einstellen wollen.
    SwLineLayout *pOldCurr = pCurr;

    InitCntHyph();

    // 5298: IsParaLine() (ex.IsFirstLine) fragt auf GetParaPortion() ab.
    // wir muessen gleiche Bedingungen schaffen: in der ersten
    // Zeile formatieren wir SwParaPortions...
    if( pOldCurr->IsParaPortion() )
    {
        SwParaPortion *pPara = new SwParaPortion();
        SetParaPortion( &rInf, pPara );
        pCurr = pPara;
        ASSERT( IsParaLine(), "SwTxtFormatter::Hyphenate: not the first" );
    }
    else
        pCurr = new SwLineLayout();

    nWrdStart = FormatLine( nWrdStart );

    // Man muss immer im Hinterkopf behalten, dass es z.B.
    // Felder gibt, die aufgetrennt werden koennen ...
    if( pCurr->PrtWidth() && pCurr->GetLen() )
    {
        // Wir muessen uns darauf einstellen, dass in der Zeile
        // FlyFrms haengen, an denen auch umgebrochen werden darf.
        // Wir suchen also die erste HyphPortion in dem angegebenen
        // Bereich.

        SwLinePortion *pPos = pCurr->GetPortion();
        const xub_StrLen nPamStart = rHyphInf.nStart;
        nWrdStart = nStart;
        const xub_StrLen nEnd = rHyphInf.GetEnd();
        while( pPos )
        {
            // Entweder wir liegen drueber oder wir laufen gerade auf eine
            // Hyphportion die am Ende der Zeile oder vor einem Flys steht.
            if( nWrdStart >= nEnd )
            {
                nWrdStart = 0;
                break;
            }

            if( nWrdStart >= nPamStart && pPos->InHyphGrp()
                && ( !pPos->IsSoftHyphPortion()
                     || ((SwSoftHyphPortion*)pPos)->IsExpand() ) )
            {
                break;
            }

            nWrdStart += pPos->GetLen();
            pPos = pPos->GetPortion();
        }
        // Wenn pPos 0 ist, wurde keine Trennstelle ermittelt.
        if( !pPos )
            nWrdStart = 0;
    }

    // Das alte LineLayout wird wieder eingestellt ...
    delete pCurr;
    pCurr = pOldCurr;

    if( pOldCurr->IsParaPortion() )
    {
        SetParaPortion( &rInf, (SwParaPortion*)pOldCurr );
        ASSERT( IsParaLine(), "SwTxtFormatter::Hyphenate: even not the first" );
    }

    if( nWrdStart )
    {
        // nWrdStart bezeichnet nun die Position im String, der
        // fuer eine Trennung zur Debatte steht.
        // Start() hangelt sich zum End()
        rHyphInf.nWordStart = nWrdStart;

        xub_StrLen nLen = 0;
        const xub_StrLen nEnd = nWrdStart;

        // Wir suchen vorwaerts
        Reference< XHyphenatedWord > xHyphWord;

        Boundary aBound =
            pBreakIt->xBreak->getWordBoundary( rInf.GetTxt(), nWrdStart,
            pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ), WordType::DICTIONARY_WORD, sal_True );
        nWrdStart = aBound.startPos;
        nLen = aBound.endPos - nWrdStart;
        bRet = 0 != nLen;
        if( bRet )
        {
            XubString aSelTxt( rInf.GetTxt().Copy(nWrdStart, nLen) );
            xub_StrLen nCnt = 0;
            for( xub_StrLen i = 0; i < nLen; ++i )
            {
                sal_Unicode cCh = aSelTxt.GetChar(i);
                if( (CH_TXTATR_BREAKWORD == cCh || CH_TXTATR_INWORD == cCh )
                     && rInf.HasHint( nWrdStart + i ) )
                {
                    aSelTxt.Erase( i , 1 );
                    nCnt++;
                    --nLen;
                    if( i )
                        --i;
                }
            }
            {
                MSHORT nMinTrail = 0;
                if( nWrdStart + nLen > nEnd )
                    nMinTrail = nWrdStart + nLen - nEnd - 1;

                //!! rHyphInf.SetHyphWord( ... ) muß hier geschehen
                xHyphWord = rInf.HyphWord( aSelTxt, nMinTrail );
                bRet = xHyphWord.is();
                if ( !rHyphInf.IsCheck() && sal_False == bRet )
                    rHyphInf.SetNoLang( sal_True );
            }

            if( bRet )
            {
                rHyphInf.SetHyphWord( xHyphWord );
                rHyphInf.nWordStart = nWrdStart;
                rHyphInf.nWordLen   = nLen+nCnt;
                rHyphInf.SetNoLang( sal_False );
                rHyphInf.SetCheck( sal_True );
            }
#ifdef DEBUGGY
            if( OPTDBG( rInf ) )
            {
                ASSERT( aSelTxt == aHyphWord,
                        "!SwTxtFormatter::Hyphenate: different words, different planets" );
                aDbstream << "Diff: \"" << aSelTxt.GetStr() << "\" != \""
                          << aHyphWord.GetStr() << "\"" << endl;
                ASSERT( bRet, "!SwTxtFormatter::Hyphenate: three of a perfect pair" );
                aDbstream << "Hyphenate: ";
            }
#endif
        }
    }
    return bRet;
}

/*************************************************************************
 *                      SwTxtPortion::FormatHyph()
 *************************************************************************/

sal_Bool SwTxtPortion::FormatHyph( SwTxtFormatInfo &rInf )
{
    sal_Bool bFull = sal_False;
    const sal_Bool bHyph = rInf.ChgHyph( sal_True );
    if( rInf.IsHyphenate() )
    {
        SwTxtGuess aGuess;
        // const KSHORT nOldWidth = rInf.Width();
        // Fly-Situationen muessen noch behandelt werden.
        // rInf.Width( rInf.RealWidth() );
        bFull = IsHyphenate( rInf, aGuess );
        // rInf.Width( nOldWidth );
    }
    rInf.ChgHyph( bHyph );
#ifdef DEBUG
    // alles schon gesehen, z.B: "Schiff{-}fahrt", SoftHyph mit der
    // Hand eingeben, und auf einmal passt "Schiff-" ...
//  ASSERT( bFull, "!SwTxtPortion::FormatHyph: not full" );
#endif
    return bFull;
}

/*************************************************************************
 *                      lcl_AdjSoftHyph(...)
 *************************************************************************/

xub_StrLen lcl_AdjSoftHyph( SwTxtSizeInfo& rInf, const XubString aOrgTxt,
                        const xub_StrLen nPos, const xub_StrLen nWordStart )
{
    xub_StrLen nNewPos = 0;
    const xub_StrLen nEnd = Min( aOrgTxt.Len(), nPos );
    for( xub_StrLen i = 0; i < nEnd; ++i )
    {
        sal_Unicode cCh = aOrgTxt.GetChar(i);
        if( ( CH_TXTATR_BREAKWORD == cCh || CH_TXTATR_INWORD == cCh )
            && rInf.HasHint( nWordStart + i ) )
            ++nNewPos;
        ++nNewPos;
    }
    return nNewPos;
}

/*************************************************************************
 *                      SwTxtPortion::IsHyphenate()
 *************************************************************************/

sal_Bool SwTxtPortion::IsHyphenate( SwTxtFormatInfo &rInf, SwTxtGuess &rGuess )
{
    ASSERT( !pPortion, "SwTxtPortion::Hyphenate: another portion, another planet..." );
    if( rInf.IsHyphForbud() ||
        pPortion || // robust
        // Mehrzeilige Felder duerfen nicht interaktiv getrennt werden.
        ( rInf.IsInterHyph() && InFldGrp() ) )
        return sal_False;

    const sal_Bool bDoSoftHyph = rInf.IsUnderFlow() && rInf.GetSoftHyphPos();

    KSHORT nWidth = bDoSoftHyph ? rInf.RealWidth() : rInf.Width();

    if( nWidth <= rInf.X() )
    {
        // robust
        ASSERT( !this, "+SwTxtPortion::Hyphenate: La quenta por favor." );
        return sal_False;
    }
    nWidth -= rInf.X();

    // Ab hier beginnt das 'alte' Hyphenate()

    // Die Breite des Trennstriches muss beruecksichtigt werden, wenn fest-
    // gestellt werden soll, ob das Wort auf die Zeile passt.
    SwHyphPortion aHyphPor;
    aHyphPor.SetLen( 1 );

    static const void* pLastMagicNo = 0;
//  static SwPosSize aMiniCache;
    static KSHORT aMiniCacheH = 0, aMiniCacheW = 0;
    const void* pTmpMagic;
    MSHORT nFntIdx;
    rInf.GetFont()->GetMagic( pTmpMagic, nFntIdx, rInf.GetFont()->GetActual() );
    if( !pLastMagicNo || pLastMagicNo != pTmpMagic )
    {
        pLastMagicNo = pTmpMagic;
//      aMiniCache = aHyphPor.GetTxtSize( rInf );
        (SwPosSize&)aHyphPor = aHyphPor.GetTxtSize( rInf );
        aMiniCacheH = aHyphPor.Height(), aMiniCacheW = aHyphPor.Width();
    }
//  (SwPosSize&)aHyphPor = aMiniCache;
    else
        aHyphPor.Height( aMiniCacheH ), aHyphPor.Width( aMiniCacheW );

    aHyphPor.SetLen( 0 );
    if( !aHyphPor.Width() )
    {   // robust
        ASSERT( aHyphPor.Width(), "+SwTxtPortion::Hyphenate: annorectic HyphPor" );
        return sal_False;
    }

    // Wenn der Trennstrich breiter als der zur Verfuegung stehende Platz ist...
    if( nWidth <= aHyphPor.Width() )
        return sal_False;

    SwTxtSizeInfo aInf( rInf );

    xub_StrLen nLastChar;
    // Wir machen uns breit und tun so, als ob wir noch passen wuerden.
    const KSHORT nOldWidth = Width();
    const xub_StrLen nOldLen   = GetLen();
    if( bDoSoftHyph )
        nLastChar = rInf.GetSoftHyphPos() + 1;
    else
    {
        Width( rGuess.LeftWidth() );
        SetLen( rGuess.RightPos() - rInf.GetIdx() + 1 );
        nLastChar = rGuess.HyphWord()->getHyphenationPos();
        if( !nLastChar )
            nLastChar = rInf.GetIdx() +
                            GetCrsrOfst( nWidth - aHyphPor.Width(), aInf );
        else
            nLastChar += rGuess.LeftPos() + 1;
        Width( nOldWidth);
        SetLen( nOldLen );

        // "Hunde. XXX", LeftPos auf ".", GetWord: "Hunde"
        // "spuerbar erweitert", LeftPos auf "r", LastChar auf " "
        if( rInf.GetIdx() + GetLen() != nLastChar &&
            rGuess.LeftPos() + 1 >= nLastChar )
            return sal_False;
    }

    xub_StrLen nWordStart, nWordLen;

    if( !pBreakIt->xBreak.is() )
        return sal_False;
    Boundary aBound =
        pBreakIt->xBreak->getWordBoundary( rInf.GetTxt(), nLastChar,
        pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ),
        WordType::DICTIONARY_WORD, sal_True );
    nWordStart = aBound.startPos;
    nWordLen = aBound.endPos - nWordStart;

    // Textabschnitte unter 2 Zeichen trennen wir nicht mehr
    if( 2 > nWordLen )
        return sal_False;

    // Das gefundene Wort muss natuerlich im scope liegen:
    // (kann schon mal vorkommen, dass es nicht so ist, kein ASSERT!)
    if( rInf.GetIdx() + 2 >= nWordStart + nWordLen )
        return sal_False;

    const XubString aOrgTxt( rInf.GetTxt().Copy( nWordStart, nWordLen ) );
    XubString aTxt( aOrgTxt );
    xub_StrLen nDel = 0;

    // Der Hyphenator kriegt nie SoftHyphs zu sehen. Den ganzen Aerger
    // muss die TxtPortion ausbaden. Es ist ein Spiel mit dem Feuer:
    // In dem Moment, wo Laengen in Portions eingestellt werden oder
    // die HyphPos herausgereicht wird, muessen die SoftHyphs miteinbezogen
    // werden.
    for( xub_StrLen i = 0; i < nWordLen; ++i )
    {
        sal_Unicode cCh = aOrgTxt.GetChar(i);
        if( ( CH_TXTATR_BREAKWORD == cCh || CH_TXTATR_INWORD == cCh )
            && rInf.HasHint( nWordStart + i ) )
        {
            aTxt.Erase( i - nDel, 1 );
            const xub_StrLen nWordPos = nWordStart + i;
            if( nWordPos - nDel < nLastChar )
                --nLastChar;
            ++nDel;

            // Wenn in unserem Wort ein SoftHyphen steht,
            // dann hat das Vorrang, wir returnen sal_False,
            // es sei denn wir sind in der interaktiven Trennung!
            if ( rInf.IsSoftHyph( nWordPos ) && nWordPos < rInf.GetIdx()
                 && !rInf.IsInterHyph() )
                    return sal_False;
        }
    }

    nWordLen -= nDel;
    xub_StrLen nHyphPos = 0;

    // MinTrail uebersteuert das Absatzattribut fuer nMinTrail.
    // (Anzahl der Zeichen die auf die naechste Zeile muessen)
    MSHORT nMinTrail = 0;
    if(nWordStart + nWordLen > nLastChar)
        nMinTrail = nWordStart + nWordLen - nLastChar;

    if( bDoSoftHyph && aTxt.Len() > nMinTrail )
    {
        //! make softhyphens work for alternative spellings where the text length
        //! changes eg "Schiffahrt" (old german spelling)
        Reference< XHyphenator >  xHyph( ::GetHyphenator() );
        DBG_ASSERT( xHyph.is(), "Hyphenator is missing");
        if (xHyph.is())
        {
            xub_StrLen nHyphenationPos = aTxt.Len() - nMinTrail - 1;
                //! subtract 1 since the UNO-interface is 0 based
            Reference< XHyphenatedWord >
                    xHW = xHyph->queryAlternativeSpelling( OUString(aTxt),
                            SvxCreateLocale( rInf.GetFont()->GetLanguage() ),
                            nHyphenationPos,
                            Sequence< PropertyValue >() );
            if (xHW.is()  &&  xHW->isAlternativeSpelling())
            {
                nMinTrail -= xHW->getHyphenPos() - nHyphenationPos;
            }
        }
    }

    Reference< XHyphenatedWord >  xHyphWord = rGuess.HyphWord();
            // rInf.HyphWord( aTxt, nMinTrail );
    sal_Bool bRet = xHyphWord.is();
    if( !bRet )
        return sal_False;

    // Die Laenge ist nicht der Index !
    CONST sal_Bool bAlter = xHyphWord.is() &&
                        xHyphWord->isAlternativeSpelling();

    // Wenn kein Alternativwort gefunden wurde und ein SoftHyph
    // gerade die zweite Runde dreht, dann wollen wir uns nicht
    // einmischen.
    if( IsSoftHyphPortion() )
    {
        // check for: bAlter => xHyphWord.is()
        DBG_ASSERT(!bAlter || xHyphWord.is(), "NULL pointer");

        if ( bAlter &&
             rInf.GetIdx() - nWordStart - 1 == xHyphWord->getHyphenationPos() )
            return sal_True;
        else
            return sal_False;
    }
//  nWordLen = xHyphWord->getHyphenationPos() + 1;
    nWordLen = xHyphWord->getHyphenPos() + 1;

    if( 2 > nWordLen )
        return sal_False;
    nHyphPos = lcl_AdjSoftHyph( rInf, aOrgTxt, nWordLen, nWordStart );

    // Wir muessen mit dem schlimmsten rechnen, z.B., dass die
    // gefundene Trennstelle vor unserer Portion liegt.

    if( (nWordStart + nHyphPos) < (rInf.GetIdx() + 2) ||
        nWordLen >= aTxt.Len() )
        return sal_False;

    SwHyphPortion *pHyphPor;
    if( bAlter )
    {
        // check for: bAlter => xHyphWord.is()
        DBG_ASSERT(!bAlter || xHyphWord.is(), "NULL pointer");

        SvxAlternativeSpelling aAltSpell;
        aAltSpell = SvxGetAltSpelling( xHyphWord );
        DBG_ASSERT( aAltSpell.bIsAltSpelling, "no alternatve spelling" );

        XubString  aAltTxt   = aAltSpell.aReplacement;
        xub_StrLen nTxtStart = aAltSpell.nChangedPos;
        xub_StrLen nTxtEnd   = aAltSpell.nChangedLength + nTxtStart;

        if( bDoSoftHyph )
            pHyphPor = new SwSoftHyphStrPortion( aAltTxt );
        else
            pHyphPor = new SwHyphStrPortion( aAltTxt );
        // pHyphPor wird auf die Laenge eingestellt, die im Original-
        // String ersetzt werden soll.
        nTxtStart = lcl_AdjSoftHyph( rInf, aOrgTxt, nTxtStart, nWordStart );
        nTxtEnd   = lcl_AdjSoftHyph( rInf, aOrgTxt, nTxtEnd, nWordStart );
        ASSERT(nTxtEnd >= nTxtStart, "SwTxtPortion::Hyphenate: time to die.");
        const xub_StrLen nTmpLen = pHyphPor->GetLen();
        pHyphPor->SetLen( aAltTxt.Len() + 1 );
        (SwPosSize&)(*pHyphPor) = pHyphPor->GetTxtSize( rInf );
        pHyphPor->SetLen( nTxtEnd - nTxtStart + nTmpLen );
        nWordLen = nTxtStart;
        if( !aAltTxt.Len() )  // Beim Wrapper Debuggen beobachtet: angebliche
            ++nWordLen;    // Alternativtrennstelle ohne Unterschied zum
                           // Originaltext ( Zukkerbackerei )
    }
    else
    {
        nWordLen = lcl_AdjSoftHyph( rInf, aOrgTxt, nWordLen, nWordStart );
        // Vorsicht: der benutzte Ctor von SwTxtPortion verstellt nWhichPor!
        pHyphPor = new SwHyphPortion( aHyphPor );
        pHyphPor->SetWhichPor( POR_HYPH );
    }

    aInf.SetLen( (nWordStart + nWordLen) - rInf.GetIdx() );
    pHyphPor->SetAscent( GetAscent() );
    SetLen( aInf.GetLen()  );
    CalcTxtSize( aInf );

    // Die absolute Notbremse:
    if( nWidth < Width() + pHyphPor->Width() || !GetLen() )
    {
        delete pHyphPor;
        nHyphPos = rInf.GetIdx();
        Width( nOldWidth);
        SetLen( nOldLen );
        return sal_False;
    }
    else
    {
        Insert( pHyphPor );
        short nKern = rInf.GetFont()->CheckKerning();
        if( nKern )
            new SwKernPortion( *this, nKern );
    }

    return sal_True;
}

/*************************************************************************
 *              virtual SwHyphPortion::GetExpTxt()
 *************************************************************************/

sal_Bool SwHyphPortion::GetExpTxt( const SwTxtSizeInfo &rInf, XubString &rTxt ) const
{
    rTxt = '-';
    return sal_True;
}

/*************************************************************************
 *                 virtual SwHyphPortion::Format()
 *************************************************************************/

sal_Bool SwHyphPortion::Format( SwTxtFormatInfo &rInf )
{
    register const SwLinePortion *pLast = rInf.GetLast();
    Height( pLast->Height() );
    SetAscent( pLast->GetAscent() );
    XubString aTxt;

    if( !GetExpTxt( rInf, aTxt ) )
        return sal_False;

    PrtWidth( rInf.GetTxtSize( aTxt ).Width() );
    const sal_Bool bFull = rInf.Width() <= rInf.X() + PrtWidth();
    if( bFull && !rInf.IsUnderFlow() )
        Underflow( rInf );

    return bFull;
}

/*************************************************************************
 *              virtual SwHyphStrPortion::GetExpTxt()
 *************************************************************************/

sal_Bool SwHyphStrPortion::GetExpTxt( const SwTxtSizeInfo &, XubString &rTxt ) const
{
    rTxt = aExpand;
    return sal_True;
}

/*************************************************************************
 *                      class SwSoftHyphPortion
 *************************************************************************/

SwLinePortion *SwSoftHyphPortion::Compress() { return this; }

SwSoftHyphPortion::SwSoftHyphPortion() :
    bExpand(sal_False), nViewWidth(0), nHyphWidth(0)
{
    SetLen(1);
    SetWhichPor( POR_SOFTHYPH );
}

KSHORT SwSoftHyphPortion::GetViewWidth( const SwTxtSizeInfo &rInf ) const
{
    // Wir stehen zwar im const, aber nViewWidth sollte erst im letzten
    // Moment errechnet werden:
    if( !Width() && rInf.OnWin() && rInf.GetOpt().IsSoftHyph() && !IsExpand() )
    {
        if( !nViewWidth )
            ((SwSoftHyphPortion*)this)->nViewWidth
                = rInf.GetTxtSize( '-' ).Width();
    }
    else
        ((SwSoftHyphPortion*)this)->nViewWidth = 0;
    return nViewWidth;
}

/*  Faelle:
 *  1) SoftHyph steht in der Zeile, ViewOpt aus.
 *     -> unsichtbar, Nachbarn unveraendert
 *  2) SoftHyph steht in der Zeile, ViewOpt an.
 *     -> sichtbar, Nachbarn veraendert
 *  3) SoftHyph steht am Zeilenende, ViewOpt aus/an.
 *     -> immer sichtbar, Nachbarn unveraendert
 */

void SwSoftHyphPortion::Paint( const SwTxtPaintInfo &rInf ) const
{
    if( Width() )
    {
        rInf.DrawViewOpt( *this, POR_SOFTHYPH );
        SwExpandPortion::Paint( rInf );
    }
}

/*************************************************************************
 *                 virtual SwSoftHyphPortion::Format()
 *************************************************************************/

/* Die endgueltige Breite erhalten wir im FormatEOL().
 * In der Underflow-Phase stellen wir fest, ob ueberhaupt ein
 * alternatives Spelling vorliegt. Wenn ja ...
 *
 * Fall 1: "Au-to"
 * 1) {Au}{-}{to}, {to} passt nicht mehr => Underflow
 * 2) {-} ruft Hyphenate => keine Alternative
 * 3) FormatEOL() und bFull = sal_True
 *
 * Fall 2: "Zuc-ker"
 * 1) {Zuc}{-}{ker}, {ker} passt nicht mehr => Underflow
 * 2) {-} ruft Hyphenate => Alternative!
 * 3) Underflow() und bFull = sal_True
 * 4) {Zuc} ruft Hyphenate => {Zuk}{-}{ker}
 */

sal_Bool SwSoftHyphPortion::Format( SwTxtFormatInfo &rInf )
{
    sal_Bool bFull = sal_True;

    // Aufstand fuer die deutsche Sondertrennung
    if( rInf.IsUnderFlow()  )
    {
        if( rInf.GetSoftHyphPos() )
            return sal_True;

        const sal_Bool bHyph = rInf.ChgHyph( sal_True );
        if( rInf.IsHyphenate() )
        {
            SwTxtGuess aGuess;

            rInf.SetSoftHyphPos( rInf.GetIdx() );

            Width(0);

            // Hyphenate liefert fuer uns zurueck, ob
            // eine alternative Trennstelle vorliegt.
            // Wenn nicht alternativ getrennt wird,
            // akzeptieren wir die Stelle...
            bFull = rInf.IsInterHyph() || !IsHyphenate( rInf, aGuess );
        }
        rInf.ChgHyph( bHyph );

        if( bFull && !rInf.IsHyphForbud() )
        {
            rInf.SetSoftHyphPos(0);
            FormatEOL( rInf );
            if ( rInf.GetFly() )
                rInf.GetRoot()->SetMidHyph( sal_True );
            else
                rInf.GetRoot()->SetEndHyph( sal_True );
        }
        else
        {
            rInf.SetSoftHyphPos( rInf.GetIdx() );
            Underflow( rInf );
        }
        return sal_True;
    }

    rInf.SetSoftHyphPos(0);
    SetExpand( sal_True );
    bFull = SwHyphPortion::Format( rInf );
    SetExpand( sal_False );
    if( !bFull )
    {
        // default-maessig besitzen wir keine Breite, aber eine Hoehe
        nHyphWidth = Width();
        Width(0);
    }
    return bFull;
}

/*************************************************************************
 *                 virtual SwSoftHyphPortion::FormatEOL()
 *************************************************************************/
// Format end of Line

void SwSoftHyphPortion::FormatEOL( SwTxtFormatInfo &rInf )
{
    if( !IsExpand() )
    {
        SetExpand( sal_True );
        if( rInf.GetLast() == this )
            rInf.SetLast( FindPrevPortion( rInf.GetRoot() ) );

        // 5964: alte Werte muessen wieder zurueckgesetzt werden.
        const KSHORT nOldX   = rInf.X();
        const xub_StrLen nOldIdx = rInf.GetIdx();
        rInf.X( rInf.X() - PrtWidth() );
        rInf.SetIdx( rInf.GetIdx() - GetLen() );
        const sal_Bool bFull = SwHyphPortion::Format( rInf );
        nHyphWidth = Width();

        // 6976: Eine truebe Sache: Wir werden erlaubterweise breiter,
        // aber gleich wird noch ein Fly verarbeitet, der eine korrekte
        // X-Position braucht.
        if( bFull || !rInf.GetFly() )
            rInf.X( nOldX );
        else
            rInf.X( nOldX + Width() );
        rInf.SetIdx( nOldIdx );
    }
}

/*************************************************************************
 *              virtual SwSoftHyphPortion::GetExpTxt()
 *
 * Wir expandieren:
 * - wenn die Sonderzeichen sichtbar sein sollen
 * - wenn wir am Ende der Zeile stehen.
 * - wenn wir vor einem (echten/emuliertem) Zeilenumbruch stehen
 *************************************************************************/

sal_Bool SwSoftHyphPortion::GetExpTxt( const SwTxtSizeInfo &rInf, XubString &rTxt ) const
{
    if( IsExpand() || ( rInf.OnWin() && rInf.GetOpt().IsSoftHyph() ) ||
        ( GetPortion() && ( GetPortion()->InFixGrp() ||
          GetPortion()->IsDropPortion() || GetPortion()->IsLayPortion() ||
          GetPortion()->IsParaPortion() || GetPortion()->IsBreakPortion() ) ) )
    {
        return SwHyphPortion::GetExpTxt( rInf, rTxt );
    }
    return sal_False;
}

/*************************************************************************
 *                      SwSoftHyphStrPortion::Paint
 *************************************************************************/

void SwSoftHyphStrPortion::Paint( const SwTxtPaintInfo &rInf ) const
{
    // Bug oder feature?:
    // {Zu}{k-}{ker}, {k-} wird grau statt {-}
    rInf.DrawViewOpt( *this, POR_SOFTHYPH );
    SwHyphStrPortion::Paint( rInf );
}

SwSoftHyphStrPortion::SwSoftHyphStrPortion( const XubString &rStr )
    : SwHyphStrPortion( rStr )
{
    SetLen( 1 );
    SetWhichPor( POR_SOFTHYPHSTR );
}