/************************************************************************* * * $RCSfile: guess.cxx,v $ * * $Revision: 1.32 $ * * last change: $Author: fme $ $Date: 2002-02-20 12:44:15 $ * * 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 #ifndef _UNO_LINGU_HXX #include #endif #ifndef _SHL_HXX #include // needed for SW_MOD() macro #endif #ifndef _ERRHDL_HXX #include // ASSERTs #endif #ifndef _DLELSTNR_HXX_ #include #endif #ifndef _SWMODULE_HXX #include #endif #ifndef _TXTCFG_HXX #include #endif #ifndef _GUESS_HXX #include #endif #ifndef _INFTXT_HXX #include // SwTxtSizeInfo, SwTxtFormatInfo #endif #ifndef _SWFONT_HXX #include #endif #ifndef _BREAKIT_HXX #include #endif #ifndef _VIEWSH_HXX #include #endif #ifndef _DOC_HXX #include #endif #ifndef _COM_SUN_STAR_I18N_BREAKTYPE_HPP_ #include #endif #ifndef _COM_SUN_STAR_I18N_WORDTYPE_HPP_ #include #endif #ifndef _UNOTOOLS_CHARCLASS_HXX #include #endif #ifndef _PORFLD_HXX #include #endif using namespace ::rtl; using namespace ::com::sun::star; using namespace ::com::sun::star::uno; using namespace ::com::sun::star::i18n; using namespace ::com::sun::star::beans; using namespace ::com::sun::star::linguistic2; /************************************************************************* * SwTxtGuess::Guess * * provides information for line break calculation * returns true if no line break has to be performed * otherwise possible break or hyphenation position is determined *************************************************************************/ sal_Bool SwTxtGuess::Guess( const SwTxtPortion& rPor, SwTxtFormatInfo &rInf, const KSHORT nPorHeight ) { nCutPos = rInf.GetIdx(); // Leere Strings sind immer 0 if( !rInf.GetLen() || !rInf.GetTxt().Len() ) return sal_False; ASSERT( rInf.GetIdx() < rInf.GetTxt().Len(), "+SwTxtGuess::Guess: invalid SwTxtFormatInfo" ); ASSERT( nPorHeight, "+SwTxtGuess::Guess: no height" ); USHORT nMinSize; USHORT nMaxSizeDiff; const SwScriptInfo& rSI = ((SwParaPortion*)rInf.GetParaPortion())->GetScriptInfo(); USHORT nMaxComp = ( SW_CJK == rInf.GetFont()->GetActual() ) && rSI.CountCompChg() && ! rInf.IsMulti() && ! rPor.InFldGrp() && ! rPor.IsDropPortion() ? 10000 : 0 ; SwTwips nLineWidth = rInf.Width() - rInf.X(); const xub_StrLen nMaxLen = Min( xub_StrLen(rInf.GetTxt().Len() - rInf.GetIdx()), rInf.GetLen() ); // special case: char width > line width if( !nMaxLen || !nLineWidth ) return sal_False; KSHORT nItalic = 0; if( ITALIC_NONE != rInf.GetFont()->GetItalic() && !rInf.NotEOL() ) { #ifdef DEBUG static MSHORT nDiv = 12; nItalic = nPorHeight / nDiv; #else #ifdef MAC nItalic = nPorHeight / 4; #else nItalic = nPorHeight / 12; #endif #endif if( nItalic >= nLineWidth ) { nBreakWidth = nItalic; nCutPos = rInf.GetIdx(); return sal_False; } else nLineWidth -= nItalic; } // first check if everything fits to line if ( long ( nLineWidth ) * 2 > long ( nMaxLen ) * nPorHeight ) { // call GetTxtSize with maximum compression (for kanas) rInf.GetTxtSize( &rSI, rInf.GetIdx(), nMaxLen, nMaxComp, nMinSize, nMaxSizeDiff ); nBreakWidth = nMinSize; if ( nBreakWidth <= nLineWidth ) { // portion fits to line nCutPos = rInf.GetIdx() + nMaxLen - 1; if( nItalic && ( nCutPos + 1 ) >= rInf.GetTxt().Len() ) nBreakWidth += nItalic; // save maximum width for later use if ( nMaxSizeDiff ) rInf.SetMaxWidthDiff( (ULONG)&rPor, nMaxSizeDiff ); return sal_True; } } sal_Bool bHyph = rInf.IsHyphenate() && !rInf.IsHyphForbud(); xub_StrLen nHyphPos = 0; // nCutPos is the first character not fitting to the current line // nHyphPos is the first character not fitting to the current line, // considering an additional "-" for hyphenation if( bHyph ) { nCutPos = rInf.GetTxtBreak( nLineWidth, nMaxLen, nMaxComp, nHyphPos ); if ( !nHyphPos && rInf.GetIdx() ) nHyphPos = rInf.GetIdx() - 1; } else { nCutPos = rInf.GetTxtBreak( nLineWidth, nMaxLen, nMaxComp ); #ifndef PRODUCT if ( STRING_LEN != nCutPos ) { rInf.GetTxtSize( &rSI, rInf.GetIdx(), nCutPos - rInf.GetIdx(), nMaxComp, nMinSize, nMaxSizeDiff ); ASSERT( nMinSize <= nLineWidth, "What a Guess!!!" ); } #endif } if( nCutPos > rInf.GetIdx() + nMaxLen ) { // second check if everything fits to line nCutPos = nBreakPos = rInf.GetIdx() + nMaxLen - 1; rInf.GetTxtSize( &rSI, rInf.GetIdx(), nMaxLen, nMaxComp, nMinSize, nMaxSizeDiff ); nBreakWidth = nMinSize; // Der folgende Vergleich sollte eigenlich immer sal_True ergeben, sonst // hat es wohl bei GetTxtBreak einen Pixel-Rundungsfehler gegeben... if ( nBreakWidth <= nLineWidth ) { if( nItalic && ( nBreakPos + 1 ) >= rInf.GetTxt().Len() ) nBreakWidth += nItalic; // save maximum width for later use if ( nMaxSizeDiff ) rInf.SetMaxWidthDiff( (ULONG)&rPor, nMaxSizeDiff ); return sal_True; } } // we have to trigger an underflow for a footnote portion // which does not fit to the current line if ( rPor.IsFtnPortion() ) { nBreakPos = rInf.GetIdx(); nCutPos = rInf.GetLen(); return sal_False; } sal_Bool bChgLocale = sal_False; // if we have to apply the forbidden character rules, we have to check // if we temporarily have to change the language in order to get the // correct forbidden rules const CharClass& rCC = GetAppCharClass(); xub_StrLen nLangIndex = nCutPos; if ( nCutPos ) { // step back until a non-punctuation character is reached while ( nLangIndex && ! rCC.isLetterNumeric( rInf.GetTxt(), nLangIndex ) ) --nLangIndex; ASSERT( rSI.ScriptType( nLangIndex ), "Script is not between 1 and 4" ); // compare current script with last script bChgLocale = ( rSI.ScriptType( nLangIndex ) - 1 != rInf.GetFont()->GetActual() ); } xub_StrLen nPorLen = 0; if( CH_BLANK == rInf.GetTxt().GetChar( nCutPos ) ) { nBreakPos = nCutPos; xub_StrLen nX = nBreakPos; // we step back until a non blank character has been found // or there is only one more character left while( nX && nBreakPos > rInf.GetLineStart() + 1 && CH_BLANK == rInf.GetChar( --nX ) ) --nBreakPos; if( nBreakPos > rInf.GetIdx() ) nPorLen = nBreakPos - rInf.GetIdx(); while( ++nCutPos < rInf.GetTxt().Len() && CH_BLANK == rInf.GetChar( nCutPos ) ) ; // nothing nBreakStart = nCutPos; } else if( pBreakIt->xBreak.is() ) { // New: We should have a look into the last portion, if it was a // field portion. For this, we expand the text of the field portion // into our string. If the line break position is inside of before // the field portion, we trigger an underflow. xub_StrLen nOldIdx = rInf.GetIdx(); sal_Char cFldChr = 0; #ifdef DEBUG XubString aDebugString; #endif // be careful: a field portion can be both: 0x01 (common field) // or 0x02 (the follow of a footnode) if ( rInf.GetLast() && rInf.GetLast()->InFldGrp() && ! rInf.GetLast()->IsFtnPortion() && rInf.GetIdx() > rInf.GetLineStart() && CH_TXTATR_BREAKWORD == ( cFldChr = rInf.GetTxt().GetChar( rInf.GetIdx() - 1 ) ) ) { SwFldPortion* pFld = (SwFldPortion*)rInf.GetLast(); XubString aTxt; pFld->GetExpTxt( rInf, aTxt ); if ( aTxt.Len() ) { nFieldDiff = aTxt.Len() - 1; nCutPos += nFieldDiff; nHyphPos += nFieldDiff; #ifdef DEBUG aDebugString = rInf.GetTxt(); #endif XubString& rOldTxt = (XubString&)rInf.GetTxt(); rOldTxt.Erase( rInf.GetIdx() - 1, 1 ); rOldTxt.Insert( aTxt, rInf.GetIdx() - 1 ); rInf.SetIdx( rInf.GetIdx() + nFieldDiff ); } else cFldChr = 0; } LineBreakHyphenationOptions aHyphOpt; Reference< XHyphenator > xHyph; if( bHyph ) { xHyph = ::GetHyphenator(); aHyphOpt = LineBreakHyphenationOptions( xHyph, rInf.GetHyphValues(), nHyphPos ); } // We have to switch the current language if we have a script // change at nCutPos. Otherwise LATIN punctuation would never // be allowed to be hanging punctuation. LanguageType aLang = bChgLocale ? rInf.GetTxtFrm()->GetTxtNode()->GetLang( nLangIndex - nFieldDiff ) : rInf.GetFont()->GetLanguage(); const ForbiddenCharacters aForbidden( *rInf.GetTxtFrm()->GetNode()->GetDoc()-> GetForbiddenCharacters( aLang, TRUE )); const sal_Bool bAllowHanging = rInf.IsHanging() && ! rInf.IsMulti() && ! rPor.InFldGrp(); LineBreakUserOptions aUserOpt( aForbidden.beginLine, aForbidden.endLine, rInf.HasForbiddenChars(), bAllowHanging, sal_False ); //! register listener to LinguServiceEvents now in order to get //! notified about relevant changes in the future SwModule *pModule = SW_MOD(); if (!pModule->GetLngSvcEvtListener().is()) pModule->CreateLngSvcEvtListener(); // determines first possible line break from nRightPos to // start index of current line LineBreakResults aResult = pBreakIt->xBreak->getLineBreak( rInf.GetTxt(), nCutPos, pBreakIt->GetLocale(aLang), rInf.GetLineStart(), aHyphOpt, aUserOpt ); nBreakPos = (xub_StrLen)aResult.breakIndex; // if we are formatting multi portions we want to allow line breaks // at the border between single line and multi line portion // we have to be carefull with footnote portions, they always come in // with an index 0 if ( nBreakPos < rInf.GetLineStart() && rInf.IsFirstMulti() && ! rInf.IsFtnInside() ) nBreakPos = rInf.GetLineStart(); nBreakStart = nBreakPos; bHyph = BreakType::HYPHENATION == aResult.breakType; if ( bHyph && nBreakPos != STRING_LEN) { // found hyphenation position within line // nBreakPos is set to the hyphenation position xHyphWord = aResult.rHyphenatedWord; nBreakPos += xHyphWord->getHyphenationPos() + 1; #ifdef DEBUG // e.g., Schif-fahrt, referes to our string const String aWord = xHyphWord->getWord(); // e.g., Schiff-fahrt, referes to the word after hyphenation const String aHyphenatedWord = xHyphWord->getHyphenatedWord(); // e.g., Schif-fahrt: 5, referes to our string const USHORT nHyphenationPos = xHyphWord->getHyphenationPos(); // e.g., Schiff-fahrt: 6, referes to the word after hyphenation const USHORT nHyphenPos = xHyphWord->getHyphenPos(); #endif // if not in interactive mode, we have to break behind a soft hyphen if ( ! rInf.IsInterHyph() && rInf.GetIdx() ) { const long nSoftHyphPos = xHyphWord->getWord().indexOf( CHAR_SOFTHYPHEN ); if ( nSoftHyphPos >= 0 && nBreakStart + nSoftHyphPos <= nBreakPos && nBreakPos > rInf.GetLineStart() ) nBreakPos = rInf.GetIdx() - 1; } if( nBreakPos >= rInf.GetIdx() ) { nPorLen = nBreakPos - rInf.GetIdx(); if( '-' == rInf.GetTxt().GetChar( nBreakPos - 1 ) ) xHyphWord = NULL; } } else if ( !bHyph && nBreakPos >= rInf.GetLineStart() ) { ASSERT( nBreakPos != STRING_LEN, "we should have found a break pos" ); // found break position within line xHyphWord = NULL; // check, if break position is soft hyphen and an underflow // has to be triggered if( nBreakPos > rInf.GetLineStart() && rInf.GetIdx() && CHAR_SOFTHYPHEN == rInf.GetTxt().GetChar( nBreakPos - 1 ) ) nBreakPos = rInf.GetIdx() - 1; // Delete any blanks at the end of a line, but be careful: // If a field has been expanded, we do not want to delete any // blanks inside the field portion. This would cause an unwanted // underflow xub_StrLen nX = nBreakPos; while( nX > rInf.GetLineStart() && ( CH_TXTATR_BREAKWORD != cFldChr || nX > rInf.GetIdx() ) && CH_BLANK == rInf.GetChar(--nX) ) nBreakPos = nX; if( nBreakPos > rInf.GetIdx() ) nPorLen = nBreakPos - rInf.GetIdx(); } else { // no line break found, setting nBreakPos to STRING_LEN // causes a break cut nBreakPos = STRING_LEN; ASSERT( nCutPos >= rInf.GetIdx(), "Deep cut" ); nPorLen = nCutPos - rInf.GetIdx(); } if( nBreakPos > nCutPos && nBreakPos != STRING_LEN ) { const xub_StrLen nHangingLen = nBreakPos - nCutPos; SwPosSize aTmpSize = rInf.GetTxtSize( &rSI, nCutPos, nHangingLen, 0 ); ASSERT( !pHanging, "A hanging portion is hanging around" ); pHanging = new SwHangingPortion( aTmpSize ); pHanging->SetLen( nHangingLen ); nPorLen = nCutPos - rInf.GetIdx(); } // If we expanded a field, we must repair the original string. // In case we do not trigger an underflow, we correct the nBreakPos // value, but we cannot correct the nBreakStart value: // If we have found a hyphenation position, nBreakStart can lie before // the field. if ( CH_TXTATR_BREAKWORD == cFldChr ) { if ( nBreakPos < rInf.GetIdx() ) nBreakPos = nOldIdx - 1; else if ( STRING_LEN != nBreakPos ) { ASSERT( nBreakPos >= nFieldDiff, "I've got field trouble!" ); nBreakPos -= nFieldDiff; } ASSERT( nCutPos >= rInf.GetIdx() && nCutPos >= nFieldDiff, "I've got field trouble, part2!" ); nCutPos -= nFieldDiff; XubString& rOldTxt = (XubString&)rInf.GetTxt(); rOldTxt.Erase( nOldIdx - 1, nFieldDiff + 1 ); rOldTxt.Insert( cFldChr, nOldIdx - 1 ); rInf.SetIdx( nOldIdx ); #ifdef DEBUG ASSERT( aDebugString == rInf.GetTxt(), "Somebody, somebody, somebody put something in my string" ); #endif } } if( nPorLen ) { rInf.GetTxtSize( &rSI, rInf.GetIdx(), nPorLen, nMaxComp, nMinSize, nMaxSizeDiff ); // save maximum width for later use if ( nMaxSizeDiff ) rInf.SetMaxWidthDiff( (ULONG)&rPor, nMaxSizeDiff ); nBreakWidth = nItalic + nMinSize; } else nBreakWidth = 0; if( pHanging ) nBreakPos = nCutPos; return sal_False; } /************************************************************************* * SwTxtGuess::AlternativeSpelling *************************************************************************/ // returns true if word at position nPos has a diffenrent spelling // if hyphenated at this position (old german spelling) sal_Bool SwTxtGuess::AlternativeSpelling( const SwTxtFormatInfo &rInf, const xub_StrLen nPos ) { // get word boundaries xub_StrLen nWordLen; Boundary aBound = pBreakIt->xBreak->getWordBoundary( rInf.GetTxt(), nPos, pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ), WordType::DICTIONARY_WORD, sal_True ); nBreakStart = (xub_StrLen)aBound.startPos; nWordLen = aBound.endPos - nBreakStart; // if everything else fails, we want to cut at nPos nCutPos = nPos; XubString aTxt( rInf.GetTxt().Copy( nBreakStart, nWordLen ) ); // check, if word has alternative spelling Reference< XHyphenator > xHyph( ::GetHyphenator() ); ASSERT( xHyph.is(), "Hyphenator is missing"); //! subtract 1 since the UNO-interface is 0 based xHyphWord = xHyph->queryAlternativeSpelling( OUString(aTxt), pBreakIt->GetLocale( rInf.GetFont()->GetLanguage() ), nPos - nBreakStart, rInf.GetHyphValues() ); return xHyphWord.is() && xHyphWord->isAlternativeSpelling(); }