sw/source/core/text/porexp.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <viewopt.hxx>
  21 #include <SwPortionHandler.hxx>
  22 #include "inftxt.hxx"
  23 #include "porexp.hxx"
  24
  25 TextFrameIndex SwExpandPortion::GetModelPositionForViewPoint(const sal_uInt16 nOfst) const
  26 { return SwLinePortion::GetModelPositionForViewPoint( nOfst ); }
  27
  28 bool SwExpandPortion::GetExpText( const SwTextSizeInfo&, OUString &rText ) const
  29 {
  30     rText.clear();
  31     // Do not do: return 0 != rText.Len();
  32     // Reason being: empty fields replace CH_TXTATR with an empty string
  33     return true;
  34 }
  35
  36 void SwExpandPortion::HandlePortion( SwPortionHandler& rPH ) const
  37 {
  38     rPH.Special( GetLen(), OUString(), GetWhichPor() );
  39 }
  40
  41 void SwExpandPortion::dumpAsXml(xmlTextWriterPtr pWriter, const OUString& rText,
  42                                 TextFrameIndex& nOffset) const
  43 {
  44     (void)xmlTextWriterStartElement(pWriter, BAD_CAST("SwExpandPortion"));
  45     dumpAsXmlAttributes(pWriter, rText, nOffset);
  46     nOffset += GetLen();
  47
  48     (void)xmlTextWriterEndElement(pWriter);
  49 }
  50
  51 SwPosSize SwExpandPortion::GetTextSize( const SwTextSizeInfo &rInf ) const
  52 {
  53     SwTextSlot aDiffText( &rInf, this, false, false );
  54     return rInf.GetTextSize();
  55 }
  56
  57 bool SwExpandPortion::Format( SwTextFormatInfo &rInf )
  58 {
  59     SwTextSlot aDiffText( &rInf, this, true, false );
  60     TextFrameIndex const nFullLen = rInf.GetLen();
  61
  62     // As odd as it may seem: the query for GetLen() must return
  63     // false due to the ExpandPortions _after_ the aDiffText (see SoftHyphs)
  64     // caused by the SetFull ...
  65     if( !nFullLen )
  66     {
  67         // Do not Init(), because we need height and ascent
  68         Width(0);
  69         return false;
  70     }
  71     return SwTextPortion::Format( rInf );
  72 }
  73
  74 void SwExpandPortion::Paint( const SwTextPaintInfo &rInf ) const
  75 {
  76     rInf.DrawCSDFHighlighting(*this); // here it detects as CS and not DF
  77
  78     SwTextSlot aDiffText( &rInf, this, true, true );
  79     const SwFont aOldFont = *rInf.GetFont();
  80     if( GetJoinBorderWithPrev() )
  81         const_cast<SwTextPaintInfo&>(rInf).GetFont()->SetLeftBorder(nullptr);
  82     if( GetJoinBorderWithNext() )
  83         const_cast<SwTextPaintInfo&>(rInf).GetFont()->SetRightBorder(nullptr);
  84 //    rInf.DrawCSDFHighlighting(*this); // here it detects as DF and only the '/' is detected as CS
  85
  86     rInf.DrawBackBrush( *this );
  87     rInf.DrawBorder( *this );
  88
  89     // Do we have to repaint a post it portion?
  90     if( rInf.OnWin() && mpNextPortion && !mpNextPortion->Width() )
  91         mpNextPortion->PrePaint( rInf, this );
  92
  93     // The contents of field portions is not considered during the
  94     // calculation of the directions. Therefore we let vcl handle
  95     // the calculation by removing the BIDI_STRONG_FLAG temporarily.
  96     SwLayoutModeModifier aLayoutModeModifier( *rInf.GetOut() );
  97     aLayoutModeModifier.SetAuto();
  98
  99     // ST2
 100     if ( rInf.GetSmartTags() || rInf.GetGrammarCheckList() )
 101         rInf.DrawMarkedText( *this, rInf.GetLen(), false,
 102             nullptr != rInf.GetSmartTags(), nullptr != rInf.GetGrammarCheckList() );
 103     else
 104         rInf.DrawText( *this, rInf.GetLen() );
 105
 106     if( GetJoinBorderWithPrev() || GetJoinBorderWithNext() )
 107         *const_cast<SwTextPaintInfo&>(rInf).GetFont() = aOldFont;
 108 }
 109
 110 SwLinePortion *SwBlankPortion::Compress() { return this; }
 111
 112 /**
 113  * If a Line is full of HardBlanks and overflows, we must not generate
 114  * underflows!
 115  * Causes problems with Fly
 116  */
 117 sal_uInt16 SwBlankPortion::MayUnderflow( const SwTextFormatInfo &rInf,
 118     TextFrameIndex const nIdx, bool bUnderflow)
 119 {
 120     if( rInf.StopUnderflow() )
 121         return 0;
 122     const SwLinePortion *pPos = rInf.GetRoot();
 123     if( pPos->GetNextPortion() )
 124         pPos = pPos->GetNextPortion();
 125     while( pPos && pPos->IsBlankPortion() )
 126         pPos = pPos->GetNextPortion();
 127     if( !pPos || !rInf.GetIdx() || ( !pPos->GetLen() && pPos == rInf.GetRoot() ) )
 128         return 0; // There are just BlankPortions left
 129
 130     // If a Blank is preceding us, we do not need to trigger underflow
 131     // If a Blank is succeeding us, we do not need to pass on the underflow
 132     if (bUnderflow
 133         && nIdx + TextFrameIndex(1) < TextFrameIndex(rInf.GetText().getLength())
 134         && CH_BLANK == rInf.GetText()[sal_Int32(nIdx) + 1])
 135     {
 136         return 0;
 137     }
 138     if( nIdx && !const_cast<SwTextFormatInfo&>(rInf).GetFly() )
 139     {
 140         while( pPos && !pPos->IsFlyPortion() )
 141             pPos = pPos->GetNextPortion();
 142         if( !pPos )
 143         {
 144         // We check to see if there are useful line breaks, blanks or fields etc. left
 145         // In case there still are some, no underflow
 146         // If there are Flys, we still allow the underflow
 147             TextFrameIndex nBlank = nIdx;
 148             while( --nBlank > rInf.GetLineStart() )
 149             {
 150                 const sal_Unicode cCh = rInf.GetChar( nBlank );
 151                 if( CH_BLANK == cCh ||
 152                     (( CH_TXTATR_BREAKWORD == cCh || CH_TXTATR_INWORD == cCh )
 153                         && rInf.HasHint( nBlank ) ) )
 154                     break;
 155             }
 156             if( nBlank <= rInf.GetLineStart() )
 157                 return 0;
 158         }
 159     }
 160     if (nIdx < TextFrameIndex(2))
 161         return 1;
 162     sal_Unicode const cCh(rInf.GetChar(nIdx - TextFrameIndex(1)));
 163     if (CH_BLANK == cCh)
 164         return 1;
 165     if( CH_BREAK == cCh )
 166         return 0;
 167     return 2;
 168 }
 169
 170 /**
 171  * Format End of Line
 172  */
 173 void SwBlankPortion::FormatEOL( SwTextFormatInfo &rInf )
 174 {
 175     sal_uInt16 nMay = MayUnderflow( rInf, rInf.GetIdx() - mnLineLength, true );
 176     if( !nMay )
 177         return;
 178
 179     if( nMay > 1 )
 180     {
 181         if( rInf.GetLast() == this )
 182            rInf.SetLast( FindPrevPortion( rInf.GetRoot() ) );
 183         rInf.X( rInf.X() - PrtWidth() );
 184         rInf.SetIdx( rInf.GetIdx() - GetLen() );
 185     }
 186     Truncate();
 187     rInf.SetUnderflow( this );
 188     if( rInf.GetLast()->IsKernPortion() )
 189         rInf.SetUnderflow( rInf.GetLast() );
 190 }
 191
 192 /**
 193  * Pass on the underflows and trigger them ourselves!
 194  */
 195 bool SwBlankPortion::Format( SwTextFormatInfo &rInf )
 196 {
 197     const bool bFull = rInf.IsUnderflow() || SwExpandPortion::Format( rInf );
 198     if( bFull && MayUnderflow( rInf, rInf.GetIdx(), rInf.IsUnderflow() ) )
 199     {
 200         Truncate();
 201         rInf.SetUnderflow( this );
 202         if( rInf.GetLast()->IsKernPortion() )
 203             rInf.SetUnderflow( rInf.GetLast() );
 204     }
 205     return bFull;
 206 }
 207
 208 void SwBlankPortion::Paint( const SwTextPaintInfo &rInf ) const
 209 {
 210     // Draw field shade (can be disabled individually)
 211     if (!m_bMulti) // No gray background for multiportion brackets
 212         rInf.DrawViewOpt(*this, PortionType::Blank);
 213
 214     if (m_cChar == CHAR_HARDBLANK)
 215     {
 216         if (rInf.GetOpt().IsBlank())
 217         {
 218             // Draw degree sign
 219             OUString aMarker = u"°";
 220
 221             SwPosSize aMarkerSize(rInf.GetTextSize(aMarker));
 222             Point aPos(rInf.GetPos());
 223
 224             std::shared_ptr<SwRect> pPortionRect = std::make_shared<SwRect>();
 225             rInf.CalcRect(*this, pPortionRect.get());
 226             aPos.AdjustX((pPortionRect->Width() / 2) - (aMarkerSize.Width() / 2));
 227
 228             SwTextPaintInfo aInf(rInf, &aMarker);
 229             aInf.SetPos(aPos);
 230             SwTextPortion aMarkerPor;
 231             aMarkerPor.Width(aMarkerSize.Width());
 232             aMarkerPor.Height(aMarkerSize.Height());
 233             aMarkerPor.SetAscent(GetAscent());
 234
 235             Color colorBackup = aInf.GetFont()->GetColor();
 236             aInf.GetFont()->SetColor(NON_PRINTING_CHARACTER_COLOR);
 237             aInf.DrawText(aMarkerPor, TextFrameIndex(aMarker.getLength()), true);
 238             aInf.GetFont()->SetColor(colorBackup);
 239         }
 240     }
 241     else
 242     {
 243         SwExpandPortion::Paint(rInf);
 244     }
 245 }
 246
 247 bool SwBlankPortion::GetExpText( const SwTextSizeInfo& /*rInf*/, OUString &rText ) const
 248 {
 249     rText = OUString(m_cChar);
 250
 251     return true;
 252 }
 253
 254 void SwBlankPortion::HandlePortion( SwPortionHandler& rPH ) const
 255 {
 256     rPH.Special( GetLen(), OUString( m_cChar ), GetWhichPor() );
 257 }
 258
 259 void SwBlankPortion::dumpAsXml(xmlTextWriterPtr pWriter, const OUString& rText,
 260                                TextFrameIndex& nOffset) const
 261 {
 262     (void)xmlTextWriterStartElement(pWriter, BAD_CAST("SwBlankPortion"));
 263     dumpAsXmlAttributes(pWriter, rText, nOffset);
 264     nOffset += GetLen();
 265
 266     (void)xmlTextWriterWriteAttribute(pWriter, BAD_CAST("char"),
 267                                       BAD_CAST(OUString(m_cChar).toUtf8().getStr()));
 268     (void)xmlTextWriterWriteAttribute(pWriter, BAD_CAST("multi"),
 269                                       BAD_CAST(OString::boolean(m_bMulti).getStr()));
 270
 271     (void)xmlTextWriterEndElement(pWriter);
 272 }
 273
 274 SwPostItsPortion::SwPostItsPortion( bool bScrpt )
 275     : m_bScript( bScrpt )
 276 {
 277     mnLineLength = TextFrameIndex(1);
 278     SetWhichPor( PortionType::PostIts );
 279 }
 280
 281 void SwPostItsPortion::Paint( const SwTextPaintInfo &rInf ) const
 282 {
 283     if( rInf.OnWin() && Width() )
 284         rInf.DrawPostIts( IsScript() );
 285 }
 286
 287 sal_uInt16 SwPostItsPortion::GetViewWidth( const SwTextSizeInfo &rInf ) const
 288 {
 289     // Unbelievable: PostIts are always visible
 290     return rInf.OnWin() ? SwViewOption::GetPostItsWidth( rInf.GetOut() ) : 0;
 291 }
 292
 293 bool SwPostItsPortion::Format( SwTextFormatInfo &rInf )
 294 {
 295     const bool bRet = SwLinePortion::Format( rInf );
 296     // PostIts should not have an effect on line height etc.
 297     SetAscent( 1 );
 298     Height( 1 );
 299     return bRet;
 300 }
 301
 302 bool SwPostItsPortion::GetExpText( const SwTextSizeInfo &rInf, OUString &rText ) const
 303 {
 304     if( rInf.OnWin() && rInf.GetOpt().IsPostIts() )
 305         rText = " ";
 306     else
 307         rText.clear();
 308     return true;
 309 }
 310
 311 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */