LCOV - code coverage report
Current view: top level - drawinglayer/source/primitive2d - textdecoratedprimitive2d.cxx (source / functions) Hit Total Coverage
Test: commit c8344322a7af75b84dd3ca8f78b05543a976dfd5 Lines: 102 126 81.0 %
Date: 2015-06-13 12:38:46 Functions: 6 7 85.7 %
Legend: Lines: hit not hit

          Line data    Source code
       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 <drawinglayer/primitive2d/textdecoratedprimitive2d.hxx>
      21             : #include <drawinglayer/primitive2d/polygonprimitive2d.hxx>
      22             : #include <drawinglayer/attribute/strokeattribute.hxx>
      23             : #include <drawinglayer/primitive2d/drawinglayer_primitivetypes2d.hxx>
      24             : #include <basegfx/matrix/b2dhommatrixtools.hxx>
      25             : #include <drawinglayer/primitive2d/texteffectprimitive2d.hxx>
      26             : #include <drawinglayer/primitive2d/shadowprimitive2d.hxx>
      27             : #include <drawinglayer/primitive2d/transformprimitive2d.hxx>
      28             : #include <drawinglayer/primitive2d/textlineprimitive2d.hxx>
      29             : #include <drawinglayer/primitive2d/textstrikeoutprimitive2d.hxx>
      30             : #include <drawinglayer/primitive2d/textbreakuphelper.hxx>
      31             : 
      32             : 
      33             : 
      34             : namespace drawinglayer
      35             : {
      36             :     namespace primitive2d
      37             :     {
      38        2448 :         void TextDecoratedPortionPrimitive2D::impCreateGeometryContent(
      39             :             std::vector< Primitive2DReference >& rTarget,
      40             :             basegfx::tools::B2DHomMatrixBufferedOnDemandDecompose& rDecTrans,
      41             :             const OUString& rText,
      42             :             sal_Int32 nTextPosition,
      43             :             sal_Int32 nTextLength,
      44             :             const ::std::vector< double >& rDXArray,
      45             :             const attribute::FontAttribute& rFontAttribute) const
      46             :         {
      47             :             // create the SimpleTextPrimitive needed in any case
      48             :             rTarget.push_back(Primitive2DReference(
      49             :                 new TextSimplePortionPrimitive2D(
      50             :                     rDecTrans.getB2DHomMatrix(),
      51             :                     rText,
      52             :                     nTextPosition,
      53             :                     nTextLength,
      54             :                     rDXArray,
      55             :                     rFontAttribute,
      56        2448 :                     getLocale(),
      57        4896 :                     getFontColor())));
      58             : 
      59             :             // see if something else needs to be done
      60        2448 :             const bool bOverlineUsed(TEXT_LINE_NONE != getFontOverline());
      61        2448 :             const bool bUnderlineUsed(TEXT_LINE_NONE != getFontUnderline());
      62        2448 :             const bool bStrikeoutUsed(TEXT_STRIKEOUT_NONE != getTextStrikeout());
      63             : 
      64        2448 :             if(bUnderlineUsed || bStrikeoutUsed || bOverlineUsed)
      65             :             {
      66             :                 // common preparations
      67        2448 :                 TextLayouterDevice aTextLayouter;
      68             : 
      69             :                 // TextLayouterDevice is needed to get metrics for text decorations like
      70             :                 // underline/strikeout/emphasis marks from it. For setup, the font size is needed
      71             :                 aTextLayouter.setFontAttribute(
      72        2448 :                     getFontAttribute(),
      73        2448 :                     rDecTrans.getScale().getX(),
      74        2448 :                     rDecTrans.getScale().getY(),
      75        9792 :                     getLocale());
      76             : 
      77             :                 // get text width
      78        2448 :                 double fTextWidth(0.0);
      79             : 
      80        2448 :                 if(rDXArray.empty())
      81             :                 {
      82           0 :                     fTextWidth = aTextLayouter.getTextWidth(rText, nTextPosition, nTextLength);
      83             :                 }
      84             :                 else
      85             :                 {
      86        2448 :                     fTextWidth = rDXArray.back() * rDecTrans.getScale().getX();
      87        2448 :                     const double fFontScaleX(rDecTrans.getScale().getX());
      88             : 
      89        7344 :                     if(!basegfx::fTools::equal(fFontScaleX, 1.0)
      90        7344 :                         && !basegfx::fTools::equalZero(fFontScaleX))
      91             :                     {
      92             :                         // need to take FontScaling out of the DXArray
      93        2448 :                         fTextWidth /= fFontScaleX;
      94             :                     }
      95             :                 }
      96             : 
      97        2448 :                 if(bOverlineUsed)
      98             :                 {
      99             :                     // create primitive geometry for overline
     100             :                     rTarget.push_back(Primitive2DReference(
     101             :                         new TextLinePrimitive2D(
     102             :                             rDecTrans.getB2DHomMatrix(),
     103             :                             fTextWidth,
     104             :                             aTextLayouter.getOverlineOffset(),
     105             :                             aTextLayouter.getOverlineHeight(),
     106             :                             getFontOverline(),
     107        1840 :                             getOverlineColor())));
     108             :                 }
     109             : 
     110        2448 :                 if(bUnderlineUsed)
     111             :                 {
     112             :                     // create primitive geometry for underline
     113             :                     rTarget.push_back(Primitive2DReference(
     114             :                         new TextLinePrimitive2D(
     115             :                             rDecTrans.getB2DHomMatrix(),
     116             :                             fTextWidth,
     117             :                             aTextLayouter.getUnderlineOffset(),
     118             :                             aTextLayouter.getUnderlineHeight(),
     119             :                             getFontUnderline(),
     120        2187 :                             getTextlineColor())));
     121             :                 }
     122             : 
     123        2448 :                 if(bStrikeoutUsed)
     124             :                 {
     125             :                     // create primitive geometry for strikeout
     126        1080 :                     if(TEXT_STRIKEOUT_SLASH == getTextStrikeout() || TEXT_STRIKEOUT_X == getTextStrikeout())
     127             :                     {
     128             :                         // strikeout with character
     129          47 :                         const sal_Unicode aStrikeoutChar(TEXT_STRIKEOUT_SLASH == getTextStrikeout() ? '/' : 'X');
     130             : 
     131             :                         rTarget.push_back(Primitive2DReference(
     132             :                             new TextCharacterStrikeoutPrimitive2D(
     133             :                                 rDecTrans.getB2DHomMatrix(),
     134             :                                 fTextWidth,
     135          47 :                                 getFontColor(),
     136             :                                 aStrikeoutChar,
     137          47 :                                 getFontAttribute(),
     138         141 :                                 getLocale())));
     139             :                     }
     140             :                     else
     141             :                     {
     142             :                         // strikeout with geometry
     143             :                         rTarget.push_back(Primitive2DReference(
     144             :                             new TextGeometryStrikeoutPrimitive2D(
     145             :                                 rDecTrans.getB2DHomMatrix(),
     146             :                                 fTextWidth,
     147        1033 :                                 getFontColor(),
     148             :                                 aTextLayouter.getUnderlineHeight(),
     149             :                                 aTextLayouter.getStrikeoutOffset(),
     150        2066 :                                 getTextStrikeout())));
     151             :                     }
     152        2448 :                 }
     153             :             }
     154             : 
     155             :             // TODO: Handle Font Emphasis Above/Below
     156        2448 :         }
     157             : 
     158        2739 :         Primitive2DSequence TextDecoratedPortionPrimitive2D::create2DDecomposition(const geometry::ViewInformation2D& /*rViewInformation*/) const
     159             :         {
     160        2739 :             if(getWordLineMode())
     161             :             {
     162             :                 // support for single word mode; split to single word primitives
     163             :                 // using TextBreakupHelper
     164         929 :                 const TextBreakupHelper aTextBreakupHelper(*this);
     165        1567 :                 const Primitive2DSequence aBroken(aTextBreakupHelper.getResult(BreakupUnit_word));
     166             : 
     167         929 :                 if(aBroken.hasElements())
     168             :                 {
     169             :                     // was indeed split to several words, use as result
     170         291 :                     return aBroken;
     171             :                 }
     172             :                 else
     173             :                 {
     174             :                     // no split, was already a single word. Continue to
     175             :                     // decompse local entity
     176         638 :                 }
     177             :             }
     178        2448 :             std::vector< Primitive2DReference > aNewPrimitives;
     179        4896 :             basegfx::tools::B2DHomMatrixBufferedOnDemandDecompose aDecTrans(getTextTransform());
     180        4896 :             Primitive2DSequence aRetval;
     181             : 
     182             :             // create basic geometry such as SimpleTextPrimitive, Overline, Underline,
     183             :             // Strikeout, etc...
     184             :             // prepare new font attributes WITHOUT outline
     185             :             const attribute::FontAttribute aNewFontAttribute(
     186        2448 :                 getFontAttribute().getFamilyName(),
     187        2448 :                 getFontAttribute().getStyleName(),
     188        2448 :                 getFontAttribute().getWeight(),
     189        2448 :                 getFontAttribute().getSymbol(),
     190        2448 :                 getFontAttribute().getVertical(),
     191        2448 :                 getFontAttribute().getItalic(),
     192        2448 :         getFontAttribute().getMonospaced(),
     193             :                 false,             // no outline anymore, handled locally
     194        2448 :                 getFontAttribute().getRTL(),
     195       22032 :                 getFontAttribute().getBiDiStrong());
     196             : 
     197             :             // handle as one word
     198        2448 :             impCreateGeometryContent(aNewPrimitives, aDecTrans, getText(), getTextPosition(), getTextLength(), getDXArray(), aNewFontAttribute);
     199             : 
     200             :             // convert to Primitive2DSequence
     201        2448 :             const sal_uInt32 nMemberCount(aNewPrimitives.size());
     202             : 
     203        2448 :             if(nMemberCount)
     204             :             {
     205        2448 :                 aRetval.realloc(nMemberCount);
     206             : 
     207       10003 :                 for(sal_uInt32 a(0); a < nMemberCount; a++)
     208             :                 {
     209        7555 :                     aRetval[a] = aNewPrimitives[a];
     210             :                 }
     211             :             }
     212             : 
     213             :             // Handle Shadow, Outline and TextRelief
     214        2448 :             if(aRetval.hasElements())
     215             :             {
     216             :                 // outline AND shadow depend on NO TextRelief (see dialog)
     217        2448 :                 const bool bHasTextRelief(TEXT_RELIEF_NONE != getTextRelief());
     218        2448 :                 const bool bHasShadow(!bHasTextRelief && getShadow());
     219        2448 :                 const bool bHasOutline(!bHasTextRelief && getFontAttribute().getOutline());
     220             : 
     221        2448 :                 if(bHasShadow || bHasTextRelief || bHasOutline)
     222             :                 {
     223        2156 :                     Primitive2DReference aShadow;
     224             : 
     225        2156 :                     if(bHasShadow)
     226             :                     {
     227             :                         // create shadow with current content (in aRetval). Text shadow
     228             :                         // is constant, relative to font size, rotated with the text and has a
     229             :                         // constant color.
     230             :                         // shadow parameter values
     231             :                         static double fFactor(1.0 / 24.0);
     232         330 :                         const double fTextShadowOffset(aDecTrans.getScale().getY() * fFactor);
     233         330 :                         static basegfx::BColor aShadowColor(0.3, 0.3, 0.3);
     234             : 
     235             :                         // preapare shadow transform matrix
     236             :                         const basegfx::B2DHomMatrix aShadowTransform(basegfx::tools::createTranslateB2DHomMatrix(
     237         330 :                             fTextShadowOffset, fTextShadowOffset));
     238             : 
     239             :                         // create shadow primitive
     240         660 :                         aShadow = Primitive2DReference(new ShadowPrimitive2D(
     241             :                             aShadowTransform,
     242             :                             aShadowColor,
     243         990 :                             aRetval));
     244             :                     }
     245             : 
     246        2156 :                     if(bHasTextRelief)
     247             :                     {
     248             :                         // create emboss using an own helper primitive since this will
     249             :                         // be view-dependent
     250        1736 :                         const basegfx::BColor aBBlack(0.0, 0.0, 0.0);
     251        1736 :                         const bool bDefaultTextColor(aBBlack == getFontColor());
     252        1736 :                         TextEffectStyle2D aTextEffectStyle2D(TEXTEFFECTSTYLE2D_RELIEF_EMBOSSED);
     253             : 
     254        1736 :                         if(bDefaultTextColor)
     255             :                         {
     256           0 :                             if(TEXT_RELIEF_ENGRAVED == getTextRelief())
     257             :                             {
     258           0 :                                 aTextEffectStyle2D = TEXTEFFECTSTYLE2D_RELIEF_ENGRAVED_DEFAULT;
     259             :                             }
     260             :                             else
     261             :                             {
     262           0 :                                 aTextEffectStyle2D = TEXTEFFECTSTYLE2D_RELIEF_EMBOSSED_DEFAULT;
     263             :                             }
     264             :                         }
     265             :                         else
     266             :                         {
     267        1736 :                             if(TEXT_RELIEF_ENGRAVED == getTextRelief())
     268             :                             {
     269           0 :                                 aTextEffectStyle2D = TEXTEFFECTSTYLE2D_RELIEF_ENGRAVED;
     270             :                             }
     271             :                             else
     272             :                             {
     273        1736 :                                 aTextEffectStyle2D = TEXTEFFECTSTYLE2D_RELIEF_EMBOSSED;
     274             :                             }
     275             :                         }
     276             : 
     277             :                         Primitive2DReference aNewTextEffect(new TextEffectPrimitive2D(
     278             :                             aRetval,
     279        1736 :                             aDecTrans.getTranslate(),
     280             :                             aDecTrans.getRotate(),
     281        3472 :                             aTextEffectStyle2D));
     282        3472 :                         aRetval = Primitive2DSequence(&aNewTextEffect, 1);
     283             :                     }
     284         420 :                     else if(bHasOutline)
     285             :                     {
     286             :                         // create outline using an own helper primitive since this will
     287             :                         // be view-dependent
     288             :                         Primitive2DReference aNewTextEffect(new TextEffectPrimitive2D(
     289             :                             aRetval,
     290         226 :                             aDecTrans.getTranslate(),
     291             :                             aDecTrans.getRotate(),
     292         226 :                             TEXTEFFECTSTYLE2D_OUTLINE));
     293         226 :                         aRetval = Primitive2DSequence(&aNewTextEffect, 1);
     294             :                     }
     295             : 
     296        2156 :                     if(aShadow.is())
     297             :                     {
     298             :                         // put shadow in front if there is one to paint timely before
     299             :                         // but placed behind content
     300         330 :                         const Primitive2DSequence aContent(aRetval);
     301         330 :                         aRetval = Primitive2DSequence(&aShadow, 1);
     302         330 :                         appendPrimitive2DSequenceToPrimitive2DSequence(aRetval, aContent);
     303        2156 :                     }
     304             :                 }
     305             :             }
     306             : 
     307        4896 :             return aRetval;
     308             :         }
     309             : 
     310        2747 :         TextDecoratedPortionPrimitive2D::TextDecoratedPortionPrimitive2D(
     311             :             // TextSimplePortionPrimitive2D parameters
     312             :             const basegfx::B2DHomMatrix& rNewTransform,
     313             :             const OUString& rText,
     314             :             sal_Int32 nTextPosition,
     315             :             sal_Int32 nTextLength,
     316             :             const ::std::vector< double >& rDXArray,
     317             :             const attribute::FontAttribute& rFontAttribute,
     318             :             const ::com::sun::star::lang::Locale& rLocale,
     319             :             const basegfx::BColor& rFontColor,
     320             :             const Color& rFillColor,
     321             : 
     322             :             // local parameters
     323             :             const basegfx::BColor& rOverlineColor,
     324             :             const basegfx::BColor& rTextlineColor,
     325             :             TextLine eFontOverline,
     326             :             TextLine eFontUnderline,
     327             :             bool bUnderlineAbove,
     328             :             TextStrikeout eTextStrikeout,
     329             :             bool bWordLineMode,
     330             :             TextEmphasisMark eTextEmphasisMark,
     331             :             bool bEmphasisMarkAbove,
     332             :             bool bEmphasisMarkBelow,
     333             :             TextRelief eTextRelief,
     334             :             bool bShadow)
     335             :         :   TextSimplePortionPrimitive2D(rNewTransform, rText, nTextPosition, nTextLength, rDXArray, rFontAttribute, rLocale, rFontColor, false, 0, rFillColor),
     336             :             maOverlineColor(rOverlineColor),
     337             :             maTextlineColor(rTextlineColor),
     338             :             meFontOverline(eFontOverline),
     339             :             meFontUnderline(eFontUnderline),
     340             :             meTextStrikeout(eTextStrikeout),
     341             :             meTextEmphasisMark(eTextEmphasisMark),
     342             :             meTextRelief(eTextRelief),
     343             :             mbUnderlineAbove(bUnderlineAbove),
     344             :             mbWordLineMode(bWordLineMode),
     345             :             mbEmphasisMarkAbove(bEmphasisMarkAbove),
     346             :             mbEmphasisMarkBelow(bEmphasisMarkBelow),
     347        2747 :             mbShadow(bShadow)
     348             :         {
     349        2747 :         }
     350             : 
     351       23012 :         bool TextDecoratedPortionPrimitive2D::decoratedIsNeeded() const
     352             :         {
     353       23012 :             return (TEXT_LINE_NONE != getFontOverline()
     354        4860 :                  || TEXT_LINE_NONE != getFontUnderline()
     355         280 :                  || TEXT_STRIKEOUT_NONE != getTextStrikeout()
     356           0 :                  || TEXT_EMPHASISMARK_NONE != getTextEmphasisMark()
     357           0 :                  || TEXT_RELIEF_NONE != getTextRelief()
     358       23012 :                  || getShadow());
     359             :         }
     360             : 
     361           0 :         bool TextDecoratedPortionPrimitive2D::operator==(const BasePrimitive2D& rPrimitive) const
     362             :         {
     363           0 :             if(TextSimplePortionPrimitive2D::operator==(rPrimitive))
     364             :             {
     365           0 :                 const TextDecoratedPortionPrimitive2D& rCompare = static_cast<const TextDecoratedPortionPrimitive2D&>(rPrimitive);
     366             : 
     367           0 :                 return (getOverlineColor() == rCompare.getOverlineColor()
     368           0 :                     && getTextlineColor() == rCompare.getTextlineColor()
     369           0 :                     && getFontOverline() == rCompare.getFontOverline()
     370           0 :                     && getFontUnderline() == rCompare.getFontUnderline()
     371           0 :                     && getTextStrikeout() == rCompare.getTextStrikeout()
     372           0 :                     && getTextEmphasisMark() == rCompare.getTextEmphasisMark()
     373           0 :                     && getTextRelief() == rCompare.getTextRelief()
     374           0 :                     && getUnderlineAbove() == rCompare.getUnderlineAbove()
     375           0 :                     && getWordLineMode() == rCompare.getWordLineMode()
     376           0 :                     && getEmphasisMarkAbove() == rCompare.getEmphasisMarkAbove()
     377           0 :                     && getEmphasisMarkBelow() == rCompare.getEmphasisMarkBelow()
     378           0 :                     && getShadow() == rCompare.getShadow());
     379             :             }
     380             : 
     381           0 :             return false;
     382             :         }
     383             : 
     384             :         // #i96475#
     385             :         // Added missing implementation. Decorations may (will) stick out of the text's
     386             :         // inking area, so add them if needed
     387       23012 :         basegfx::B2DRange TextDecoratedPortionPrimitive2D::getB2DRange(const geometry::ViewInformation2D& rViewInformation) const
     388             :         {
     389       23012 :             if(decoratedIsNeeded())
     390             :             {
     391             :                 // decoration is used, fallback to BufferedDecompositionPrimitive2D::getB2DRange which uses
     392             :                 // the own local decomposition for computation and thus creates all necessary
     393             :                 // geometric objects
     394       23012 :                 return BufferedDecompositionPrimitive2D::getB2DRange(rViewInformation);
     395             :             }
     396             :             else
     397             :             {
     398             :                 // no relevant decoration used, fallback to TextSimplePortionPrimitive2D::getB2DRange
     399           0 :                 return TextSimplePortionPrimitive2D::getB2DRange(rViewInformation);
     400             :             }
     401             :         }
     402             : 
     403             :         // provide unique ID
     404        3227 :         ImplPrimitive2DIDBlock(TextDecoratedPortionPrimitive2D, PRIMITIVE2D_ID_TEXTDECORATEDPORTIONPRIMITIVE2D)
     405             : 
     406             :     } // end of namespace primitive2d
     407             : } // end of namespace drawinglayer
     408             : 
     409             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.11