Files
loongoffice/sw/source/core/text/txthyph.cxx
Matteo Casalin 2a6b9c93af Massive KSHORT/MSHORT to sal_uInt16
Change-Id: I82a899ef0cad19d62c41753ffdce07d8e33d6c9d
2014-07-22 23:50:43 +02:00

571 lines
18 KiB
C++

/* -*- 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 <hintids.hxx>
#include <editeng/unolingu.hxx>
#include <com/sun/star/i18n/WordType.hpp>
#include <viewopt.hxx>
#include <viewsh.hxx>
#include <SwPortionHandler.hxx>
#include <porhyph.hxx>
#include <inftxt.hxx>
#include <itrform2.hxx>
#include <guess.hxx>
#include <splargs.hxx>
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::i18n;
Reference< XHyphenatedWord > SwTxtFormatInfo::HyphWord(
const OUString &rTxt, const sal_uInt16 nMinTrail )
{
if( rTxt.getLength() < 4 || m_pFnt->IsSymbol(m_pVsh) )
return 0;
Reference< XHyphenator > xHyph = ::GetHyphenator();
Reference< XHyphenatedWord > xHyphWord;
if( xHyph.is() )
xHyphWord = xHyph->hyphenate( OUString(rTxt),
g_pBreakIt->GetLocale( m_pFnt->GetLanguage() ),
rTxt.getLength() - nMinTrail, GetHyphValues() );
return xHyphWord;
}
// Wir formatieren eine Zeile fuer die interaktive Trennung
bool SwTxtFrm::Hyphenate( SwInterHyphInfo &rHyphInf )
{
OSL_ENSURE( ! IsVertical() || ! IsSwapped(),"swapped frame at SwTxtFrm::Hyphenate" );
if( !g_pBreakIt->GetBreakIter().is() )
return false;
// Wir machen den Laden erstmal dicht:
OSL_ENSURE( !IsLocked(), "SwTxtFrm::Hyphenate: this is locked" );
// 4935: Der frame::Frame muss eine gueltige SSize haben!
Calc();
GetFormatted();
bool bRet = false;
if( !IsEmpty() )
{
// Wir muessen die Trennung immer einschalten.
// Keine Angst, der SwTxtIter sichert im Hyphenate die alte Zeile.
SwTxtFrmLocker aLock( this );
if ( IsVertical() )
SwapWidthAndHeight();
SwTxtFormatInfo aInf( this, true ); // true for 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 sal_Int32 nEnd = rHyphInf.GetEnd();
while( !bRet && aLine.GetStart() < nEnd )
{
bRet = aLine.Hyphenate( rHyphInf );
if( !aLine.Next() )
break;
}
if ( IsVertical() )
SwapWidthAndHeight();
}
return bRet;
}
// 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 )
{
OSL_ENSURE( pRoot, "SetParaPortion: no root anymore" );
pInf->pPara = pRoot;
}
bool SwTxtFormatter::Hyphenate( SwInterHyphInfo &rHyphInf )
{
SwTxtFormatInfo &rInf = GetInfo();
// 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 false;
sal_Int32 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;
OSL_ENSURE( 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 sal_Int32 nPamStart = rHyphInf.nStart;
nWrdStart = nStart;
const sal_Int32 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() ) )
{
nWrdStart = nWrdStart + pPos->GetLen();
break;
}
nWrdStart = 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 );
OSL_ENSURE( IsParaLine(), "SwTxtFormatter::Hyphenate: even not the first" );
}
if( nWrdStart==0 )
return false;
// nWrdStart bezeichnet nun die Position im String, der
// fuer eine Trennung zur Debatte steht.
// Start() hangelt sich zum End()
rHyphInf.nWordStart = nWrdStart;
sal_Int32 nLen = 0;
const sal_Int32 nEnd = nWrdStart;
// Wir suchen vorwaerts
Reference< XHyphenatedWord > xHyphWord;
Boundary aBound =
g_pBreakIt->GetBreakIter()->getWordBoundary( rInf.GetTxt(), nWrdStart,
g_pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ), WordType::DICTIONARY_WORD, true );
nWrdStart = aBound.startPos;
nLen = aBound.endPos - nWrdStart;
if ( nLen == 0 )
return false;
OUString aSelTxt( rInf.GetTxt().copy(nWrdStart, nLen) );
sal_uInt16 nMinTrail = 0;
if( nWrdStart + nLen > nEnd )
nMinTrail = nWrdStart + nLen - nEnd - 1;
//!! rHyphInf.SetHyphWord( ... ) mu??? hier geschehen
xHyphWord = rInf.HyphWord( aSelTxt, nMinTrail );
if ( xHyphWord.is() )
{
rHyphInf.SetHyphWord( xHyphWord );
rHyphInf.nWordStart = nWrdStart;
rHyphInf.nWordLen = nLen;
rHyphInf.SetNoLang( false );
rHyphInf.SetCheck( true );
return true;
}
if ( !rHyphInf.IsCheck() )
rHyphInf.SetNoLang( true );
return false;
}
bool SwTxtPortion::CreateHyphen( SwTxtFormatInfo &rInf, SwTxtGuess &rGuess )
{
Reference< XHyphenatedWord > xHyphWord = rGuess.HyphWord();
OSL_ENSURE( !pPortion, "SwTxtPortion::CreateHyphen(): another portion, another planet..." );
OSL_ENSURE( xHyphWord.is(), "SwTxtPortion::CreateHyphen(): You are lucky! The code is robust here." );
if( rInf.IsHyphForbud() ||
pPortion || // robust
!xHyphWord.is() || // more robust
// Mehrzeilige Felder duerfen nicht interaktiv getrennt werden.
( rInf.IsInterHyph() && InFldGrp() ) )
return false;
SwHyphPortion *pHyphPor;
sal_Int32 nPorEnd;
SwTxtSizeInfo aInf( rInf );
// first case: hyphenated word has alternative spelling
if ( xHyphWord->isAlternativeSpelling() )
{
SvxAlternativeSpelling aAltSpell;
aAltSpell = SvxGetAltSpelling( xHyphWord );
OSL_ENSURE( aAltSpell.bIsAltSpelling, "no alternatve spelling" );
OUString aAltTxt = aAltSpell.aReplacement;
nPorEnd = aAltSpell.nChangedPos + rGuess.BreakStart() - rGuess.FieldDiff();
sal_Int32 nTmpLen = 0;
// soft hyphen at alternative spelling position?
if( rInf.GetTxt()[ rInf.GetSoftHyphPos() ] == CHAR_SOFTHYPHEN )
{
pHyphPor = new SwSoftHyphStrPortion( aAltTxt );
nTmpLen = 1;
}
else {
pHyphPor = new SwHyphStrPortion( aAltTxt );
}
// length of pHyphPor is adjusted
pHyphPor->SetLen( aAltTxt.getLength() + 1 );
(SwPosSize&)(*pHyphPor) = pHyphPor->GetTxtSize( rInf );
pHyphPor->SetLen( aAltSpell.nChangedLength + nTmpLen );
}
else
{
// second case: no alternative spelling
SwHyphPortion aHyphPor;
aHyphPor.SetLen( 1 );
static const void* pLastMagicNo = 0;
static sal_uInt16 aMiniCacheH = 0, aMiniCacheW = 0;
const void* pTmpMagic;
sal_uInt16 nFntIdx;
rInf.GetFont()->GetMagic( pTmpMagic, nFntIdx, rInf.GetFont()->GetActual() );
if( !pLastMagicNo || pLastMagicNo != pTmpMagic ) {
pLastMagicNo = pTmpMagic;
(SwPosSize&)aHyphPor = aHyphPor.GetTxtSize( rInf );
aMiniCacheH = aHyphPor.Height(), aMiniCacheW = aHyphPor.Width();
} else {
aHyphPor.Height( aMiniCacheH ), aHyphPor.Width( aMiniCacheW );
}
aHyphPor.SetLen( 0 );
pHyphPor = new SwHyphPortion( aHyphPor );
pHyphPor->SetWhichPor( POR_HYPH );
// values required for this
nPorEnd = xHyphWord->getHyphenPos() + 1 + rGuess.BreakStart()
- rGuess.FieldDiff();
}
// portion end must be in front of us
// we do not put hyphens at start of line
if ( nPorEnd > rInf.GetIdx() ||
( nPorEnd == rInf.GetIdx() && rInf.GetLineStart() != rInf.GetIdx() ) )
{
aInf.SetLen( nPorEnd - rInf.GetIdx() );
pHyphPor->SetAscent( GetAscent() );
SetLen( aInf.GetLen() );
CalcTxtSize( aInf );
Insert( pHyphPor );
short nKern = rInf.GetFont()->CheckKerning();
if( nKern )
new SwKernPortion( *this, nKern );
return true;
}
// last exit for the lost
delete pHyphPor;
BreakCut( rInf, rGuess );
return false;
}
bool SwHyphPortion::GetExpTxt( const SwTxtSizeInfo &/*rInf*/, OUString &rTxt ) const
{
rTxt = "-";
return true;
}
void SwHyphPortion::HandlePortion( SwPortionHandler& rPH ) const
{
OUString aString( '-' );
rPH.Special( GetLen(), aString, GetWhichPor() );
}
bool SwHyphPortion::Format( SwTxtFormatInfo &rInf )
{
const SwLinePortion *pLast = rInf.GetLast();
Height( pLast->Height() );
SetAscent( pLast->GetAscent() );
OUString aTxt;
if( !GetExpTxt( rInf, aTxt ) )
return false;
PrtWidth( rInf.GetTxtSize( aTxt ).Width() );
const bool bFull = rInf.Width() <= rInf.X() + PrtWidth();
if( bFull && !rInf.IsUnderflow() ) {
Truncate();
rInf.SetUnderflow( this );
}
return bFull;
}
bool SwHyphStrPortion::GetExpTxt( const SwTxtSizeInfo &, OUString &rTxt ) const
{
rTxt = aExpand;
return true;
}
void SwHyphStrPortion::HandlePortion( SwPortionHandler& rPH ) const
{
rPH.Special( GetLen(), aExpand, GetWhichPor() );
}
SwLinePortion *SwSoftHyphPortion::Compress() { return this; }
SwSoftHyphPortion::SwSoftHyphPortion() :
bExpand(false), nViewWidth(0), nHyphWidth(0)
{
SetLen(1);
SetWhichPor( POR_SOFTHYPH );
}
sal_uInt16 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(OUString('-')).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 );
}
}
/* 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 = true
*
* Fall 2: "Zuc-ker"
* 1) {Zuc}{-}{ker}, {ker} passt nicht mehr => Underflow
* 2) {-} ruft Hyphenate => Alternative!
* 3) Underflow() und bFull = true
* 4) {Zuc} ruft Hyphenate => {Zuk}{-}{ker}
*/
bool SwSoftHyphPortion::Format( SwTxtFormatInfo &rInf )
{
bool bFull = true;
// special case for old german spelling
if( rInf.IsUnderflow() )
{
if( rInf.GetSoftHyphPos() )
return true;
const bool bHyph = rInf.ChgHyph( true );
if( rInf.IsHyphenate() )
{
rInf.SetSoftHyphPos( rInf.GetIdx() );
Width(0);
// if the soft hyphend word has an alternative spelling
// when hyphenated (old german spelling), the soft hyphen
// portion has to trigger an underflow
SwTxtGuess aGuess;
bFull = rInf.IsInterHyph() ||
!aGuess.AlternativeSpelling( rInf, rInf.GetIdx() - 1 );
}
rInf.ChgHyph( bHyph );
if( bFull && !rInf.IsHyphForbud() )
{
rInf.SetSoftHyphPos(0);
FormatEOL( rInf );
if ( rInf.GetFly() )
rInf.GetRoot()->SetMidHyph( true );
else
rInf.GetRoot()->SetEndHyph( true );
}
else
{
rInf.SetSoftHyphPos( rInf.GetIdx() );
Truncate();
rInf.SetUnderflow( this );
}
return true;
}
rInf.SetSoftHyphPos(0);
SetExpand( true );
bFull = SwHyphPortion::Format( rInf );
SetExpand( false );
if( !bFull )
{
// default-maessig besitzen wir keine Breite, aber eine Hoehe
nHyphWidth = Width();
Width(0);
}
return bFull;
}
// Format end of Line
void SwSoftHyphPortion::FormatEOL( SwTxtFormatInfo &rInf )
{
if( !IsExpand() )
{
SetExpand( true );
if( rInf.GetLast() == this )
rInf.SetLast( FindPrevPortion( rInf.GetRoot() ) );
// 5964: alte Werte muessen wieder zurueckgesetzt werden.
const SwTwips nOldX = rInf.X();
const sal_Int32 nOldIdx = rInf.GetIdx();
rInf.X( rInf.X() - PrtWidth() );
rInf.SetIdx( rInf.GetIdx() - GetLen() );
const 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 );
}
}
// Wir expandieren:
// - wenn die Sonderzeichen sichtbar sein sollen
// - wenn wir am Ende der Zeile stehen.
// - wenn wir vor einem (echten/emuliertem) Zeilenumbruch stehen
bool SwSoftHyphPortion::GetExpTxt( const SwTxtSizeInfo &rInf, OUString &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 false;
}
void SwSoftHyphPortion::HandlePortion( SwPortionHandler& rPH ) const
{
const OUString aString( '-' );
const sal_uInt16 nWhich = ! Width() ?
POR_SOFTHYPH_COMP :
GetWhichPor();
rPH.Special( GetLen(), aString, nWhich );
}
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 OUString &rStr )
: SwHyphStrPortion( rStr )
{
SetLen( 1 );
SetWhichPor( POR_SOFTHYPHSTR );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */