drawinglayer/source/primitive2d/textlayoutdevice.cxx

   1 /*************************************************************************
   2  *
   3  *  OpenOffice.org - a multi-platform office productivity suite
   4  *
   5  *  $RCSfile: textlayoutdevice.cxx,v $
   6  *
   7  *  $Revision: 1.10 $
   8  *
   9  *  last change: $Author: aw $ $Date: 2008-05-27 14:11:20 $
  10  *
  11  *  The Contents of this file are made available subject to
  12  *  the terms of GNU Lesser General Public License Version 2.1.
  13  *
  14  *
  15  *    GNU Lesser General Public License Version 2.1
  16  *    =============================================
  17  *    Copyright 2005 by Sun Microsystems, Inc.
  18  *    901 San Antonio Road, Palo Alto, CA 94303, USA
  19  *
  20  *    This library is free software; you can redistribute it and/or
  21  *    modify it under the terms of the GNU Lesser General Public
  22  *    License version 2.1, as published by the Free Software Foundation.
  23  *
  24  *    This library is distributed in the hope that it will be useful,
  25  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  27  *    Lesser General Public License for more details.
  28  *
  29  *    You should have received a copy of the GNU Lesser General Public
  30  *    License along with this library; if not, write to the Free Software
  31  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  32  *    MA  02111-1307  USA
  33  *
  34  ************************************************************************/
  35
  36 // MARKER(update_precomp.py): autogen include statement, do not remove
  37 #include "precompiled_drawinglayer.hxx"
  38
  39 #include <drawinglayer/primitive2d/textlayoutdevice.hxx>
  40 #include <vcl/timer.hxx>
  41 #include <vcl/virdev.hxx>
  42 #include <vcl/font.hxx>
  43 #include <vcl/metric.hxx>
  44 #include <i18npool/mslangid.hxx>
  45 #include <drawinglayer/primitive2d/textprimitive2d.hxx>
  46
  47 //////////////////////////////////////////////////////////////////////////////
  48 // VDev RevDevice provider
  49
  50 namespace
  51 {
  52     class ImpTimedRefDev : public Timer
  53     {
  54         ImpTimedRefDev**                                        mppStaticPointerOnMe;
  55         VirtualDevice*                                          mpVirDev;
  56         sal_uInt32                                                      mnUseCount;
  57
  58     public:
  59         ImpTimedRefDev(ImpTimedRefDev** ppStaticPointerOnMe);
  60         ~ImpTimedRefDev();
  61         virtual void Timeout();
  62
  63         VirtualDevice& acquireVirtualDevice();
  64         void releaseVirtualDevice();
  65     };
  66
  67     ImpTimedRefDev::ImpTimedRefDev(ImpTimedRefDev** ppStaticPointerOnMe)
  68     :   mppStaticPointerOnMe(ppStaticPointerOnMe),
  69         mpVirDev(0L),
  70         mnUseCount(0L)
  71     {
  72         SetTimeout(3L * 60L * 1000L); // three minutes
  73         Start();
  74     }
  75
  76     ImpTimedRefDev::~ImpTimedRefDev()
  77     {
  78         OSL_ENSURE(0L == mnUseCount, "destruction of a still used ImpTimedRefDev (!)");
  79
  80         if(mppStaticPointerOnMe && *mppStaticPointerOnMe)
  81         {
  82             *mppStaticPointerOnMe = 0L;
  83         }
  84
  85         if(mpVirDev)
  86         {
  87             delete mpVirDev;
  88         }
  89     }
  90
  91     void ImpTimedRefDev::Timeout()
  92     {
  93         // for obvious reasons, do not call anything after this
  94         delete (this);
  95     }
  96
  97     VirtualDevice& ImpTimedRefDev::acquireVirtualDevice()
  98     {
  99         if(!mpVirDev)
 100         {
 101             mpVirDev = new VirtualDevice();
 102             mpVirDev->SetReferenceDevice( VirtualDevice::REFDEV_MODE_MSO1 );
 103         }
 104
 105         if(!mnUseCount)
 106         {
 107             Stop();
 108         }
 109
 110         mnUseCount++;
 111
 112         return *mpVirDev;
 113     }
 114
 115     void ImpTimedRefDev::releaseVirtualDevice()
 116     {
 117         OSL_ENSURE(mnUseCount, "mismatch call number to releaseVirtualDevice() (!)");
 118         mnUseCount--;
 119
 120         if(!mnUseCount)
 121         {
 122             Start();
 123         }
 124     }
 125 } // end of anonymous namespace
 126
 127 //////////////////////////////////////////////////////////////////////////////
 128 // access to one global ImpTimedRefDev incarnation in namespace drawinglayer::primitive
 129
 130 namespace drawinglayer
 131 {
 132     namespace primitive2d
 133     {
 134         // static pointer here
 135         static ImpTimedRefDev* pImpGlobalRefDev = 0L;
 136
 137         // static methods here
 138         VirtualDevice& acquireGlobalVirtualDevice()
 139         {
 140             if(!pImpGlobalRefDev)
 141             {
 142                 pImpGlobalRefDev = new ImpTimedRefDev(&pImpGlobalRefDev);
 143             }
 144
 145             return pImpGlobalRefDev->acquireVirtualDevice();
 146         }
 147
 148         void releaseGlobalVirtualDevice()
 149         {
 150             OSL_ENSURE(pImpGlobalRefDev, "releaseGlobalVirtualDevice() without prior acquireGlobalVirtualDevice() call(!)");
 151             pImpGlobalRefDev->releaseVirtualDevice();
 152         }
 153
 154         TextLayouterDevice::TextLayouterDevice()
 155         :       mrDevice(acquireGlobalVirtualDevice())
 156         {
 157         }
 158
 159         TextLayouterDevice::~TextLayouterDevice()
 160         {
 161             releaseGlobalVirtualDevice();
 162         }
 163
 164         void TextLayouterDevice::setFont(const Font& rFont)
 165         {
 166             mrDevice.SetFont( rFont );
 167         }
 168
 169         void TextLayouterDevice::setFontAttributes(const FontAttributes& rFontAttributes, const basegfx::B2DHomMatrix& rTransform, const ::com::sun::star::lang::Locale & rLocale)
 170         {
 171             setFont(getVclFontFromFontAttributes(rFontAttributes, rTransform, rLocale, mrDevice));
 172         }
 173
 174         void TextLayouterDevice::setFontAttributes(const FontAttributes& rFontAttributes, double fFontScaleX, double fFontScaleY, const ::com::sun::star::lang::Locale & rLocale)
 175         {
 176             setFont(getVclFontFromFontAttributes(rFontAttributes, fFontScaleX, fFontScaleY, 0.0, rLocale, mrDevice));
 177         }
 178
 179         double TextLayouterDevice::getOverlineOffset() const
 180         {
 181             const ::FontMetric& rMetric = mrDevice.GetFontMetric();
 182             double fRet = (rMetric.GetIntLeading() / 2.0) - rMetric.GetAscent();
 183             return fRet;
 184         }
 185
 186         double TextLayouterDevice::getUnderlineOffset() const
 187         {
 188             const ::FontMetric& rMetric = mrDevice.GetFontMetric();
 189             double fRet = rMetric.GetDescent() / 2.0;
 190             return fRet;
 191         }
 192
 193         double TextLayouterDevice::getStrikeoutOffset() const
 194         {
 195             const ::FontMetric& rMetric = mrDevice.GetFontMetric();
 196             double fRet = (rMetric.GetAscent() - rMetric.GetIntLeading()) / 3.0;
 197             return fRet;
 198         }
 199
 200 #ifdef WIN32
 201         double TextLayouterDevice::getCurrentFontRelation() const
 202         {
 203             const Font aFont(mrDevice.GetFont());
 204             const FontMetric aFontMetric(mrDevice.GetFontMetric(aFont));
 205             const double fWidth(aFontMetric.GetWidth());
 206             const double fHeight(aFont.GetHeight());
 207
 208             return basegfx::fTools::equalZero(fWidth) ? 1.0 : fHeight / fWidth;
 209         }
 210 #endif
 211
 212         double TextLayouterDevice::getOverlineHeight() const
 213         {
 214             const ::FontMetric& rMetric = mrDevice.GetFontMetric();
 215             double fRet = rMetric.GetIntLeading() / 2.5;
 216             return fRet;
 217         }
 218
 219         double TextLayouterDevice::getUnderlineHeight() const
 220         {
 221             const ::FontMetric& rMetric = mrDevice.GetFontMetric();
 222             double fRet = rMetric.GetDescent() / 4.0;
 223             return fRet;
 224         }
 225
 226         double TextLayouterDevice::getTextHeight() const
 227         {
 228             return mrDevice.GetTextHeight();
 229         }
 230
 231         double TextLayouterDevice::getTextWidth(
 232             const String& rText,
 233             xub_StrLen nIndex,
 234             xub_StrLen nLength) const
 235         {
 236             return mrDevice.GetTextWidth(rText, nIndex, nLength);
 237         }
 238
 239         bool TextLayouterDevice::getTextOutlines(
 240             basegfx::B2DPolyPolygonVector& rB2DPolyPolyVector,
 241             const String& rText,
 242             xub_StrLen nIndex,
 243             xub_StrLen nLength,
 244             // #i89784# added suppirt for DXArray for justified text
 245             const ::std::vector< double >& rDXArray,
 246             double fFontScaleWidth)
 247         {
 248             std::vector< sal_Int32 > aTransformedDXArray;
 249             const sal_uInt32 nDXArraySize(rDXArray.size());
 250
 251             if(nDXArraySize && basegfx::fTools::more(fFontScaleWidth, 0.0))
 252             {
 253                 OSL_ENSURE(nDXArraySize == nLength, "DXArray size does not correspond to text portion size (!)");
 254                 aTransformedDXArray.reserve(nDXArraySize);
 255
 256                 for(std::vector< double >::const_iterator aStart(rDXArray.begin()); aStart != rDXArray.end(); aStart++)
 257                 {
 258                     aTransformedDXArray.push_back(basegfx::fround((*aStart) * fFontScaleWidth));
 259                 }
 260             }
 261
 262             return mrDevice.GetTextOutlines(
 263                 rB2DPolyPolyVector,
 264                 rText,
 265                 nIndex,
 266                 nIndex,
 267                 nLength,
 268                 true,
 269                 0,
 270                 nDXArraySize ? &(aTransformedDXArray[0]) : 0);
 271         }
 272
 273         basegfx::B2DRange TextLayouterDevice::getTextBoundRect(
 274             const String& rText,
 275             xub_StrLen nIndex,
 276             xub_StrLen nLength) const
 277         {
 278             if(nLength)
 279             {
 280                 Rectangle aRect;
 281
 282                 mrDevice.GetTextBoundRect(
 283                     aRect,
 284                     rText,
 285                     nIndex,
 286                     nIndex,
 287                     nLength);
 288
 289                 // #i102556# take empty results into account
 290                 if(!aRect.IsEmpty())
 291                 {
 292                     return basegfx::B2DRange(aRect.Left(), aRect.Top(), aRect.Right(), aRect.Bottom());
 293                 }
 294             }
 295
 296             return basegfx::B2DRange();
 297         }
 298     } // end of namespace primitive2d
 299 } // end of namespace drawinglayer
 300
 301 //////////////////////////////////////////////////////////////////////////////
 302 // helper methods for vcl font handling
 303
 304 namespace drawinglayer
 305 {
 306     namespace primitive2d
 307     {
 308         Font getVclFontFromFontAttributes(
 309             const FontAttributes& rFontAttributes,
 310             const basegfx::B2DHomMatrix& rTransform,
 311             const ::com::sun::star::lang::Locale & rLocale,
 312             const OutputDevice& rOutDev)
 313         {
 314             // decompose matrix to have position and size of text
 315             basegfx::B2DVector aScale, aTranslate;
 316             double fRotate, fShearX;
 317
 318             rTransform.decompose(aScale, aTranslate, fRotate, fShearX);
 319
 320             return getVclFontFromFontAttributes(rFontAttributes, aScale.getX(), aScale.getY(), fRotate, rLocale, rOutDev);
 321         }
 322
 323         Font getVclFontFromFontAttributes(
 324             const FontAttributes& rFontAttributes,
 325             double fFontScaleX,
 326             double fFontScaleY,
 327             double fFontRotation,
 328             const ::com::sun::star::lang::Locale & rLocale,
 329             const OutputDevice& /*rOutDev*/)
 330         {
 331             sal_uInt32 nWidth(basegfx::fround(fabs(fFontScaleX)));
 332             sal_uInt32 nHeight(basegfx::fround(fabs(fFontScaleY)));
 333             Font aRetval(
 334                 rFontAttributes.getFamilyName(),
 335                 rFontAttributes.getStyleName(),
 336 #ifdef WIN32
 337                 Size(0, nHeight));
 338 #else
 339                 Size(nWidth, nHeight));
 340 #endif
 341
 342             aRetval.SetAlign(ALIGN_BASELINE);
 343             aRetval.SetCharSet(rFontAttributes.getSymbol() ? RTL_TEXTENCODING_SYMBOL : RTL_TEXTENCODING_UNICODE);
 344             aRetval.SetVertical(rFontAttributes.getVertical() ? TRUE : FALSE);
 345             aRetval.SetWeight(static_cast<FontWeight>(rFontAttributes.getWeight()));
 346             aRetval.SetItalic(rFontAttributes.getItalic() ? ITALIC_NORMAL : ITALIC_NONE);
 347             aRetval.SetOutline(rFontAttributes.getOutline());
 348             aRetval.SetLanguage(MsLangId::convertLocaleToLanguage(rLocale));
 349
 350 #ifdef WIN32
 351             // #100424# use higher precision
 352             if(!basegfx::fTools::equal(fFontScaleX, fFontScaleY))
 353             {
 354                 // #i92757#
 355                 // Removed the relative calculation with GetFontMetric() usage again. On
 356                 // the one hand it was wrong (integer division always created zero), OTOH
 357                 // calculating a scale factor from current to target width and then using
 358                 // it to actually scale the current width does nothing but set the target
 359                 // value directly. Maybe more is needed here with WIN version of font
 360                 // width/height handling, but currently, this works the simple way.
 361                 //
 362                 // As can be seen, when this can stay the simple way, the OutputDevice
 363                 // can be removed from the whole getVclFontFromFontAttributes implementations
 364                 // again and make it more VCL-independent.
 365                 //
 366                 // Adapted nWidth usage to nWidth-1 to be completely compatible with
 367                 // non-primitive version.
 368                 //
 369                 // previous stuff:
 370                 //  const FontMetric aFontMetric(rOutDev.GetFontMetric(aRetval));
 371                 //  const double fCurrentWidth(aFontMetric.GetWidth());
 372                 //  aRetval.SetWidth(basegfx::fround(fCurrentWidth * ((double)nWidth/(double)nHeight)));
 373                 aRetval.SetWidth(nWidth ? nWidth - 1 : 0);
 374             }
 375 #endif
 376
 377             if(!basegfx::fTools::equalZero(fFontRotation))
 378             {
 379                 sal_Int16 aRotate10th((sal_Int16)(fFontRotation * (-1800.0/F_PI)));
 380                 aRetval.SetOrientation(aRotate10th % 3600);
 381             }
 382
 383             return aRetval;
 384         }
 385
 386         FontAttributes getFontAttributesFromVclFont(basegfx::B2DVector& rSize, const Font& rFont, bool bRTL, bool bBiDiStrong)
 387         {
 388             FontAttributes aRetval(
 389                 rFont.GetName(),
 390                 rFont.GetStyleName(),
 391                 static_cast<sal_uInt16>(rFont.GetWeight()),
 392                 RTL_TEXTENCODING_SYMBOL == rFont.GetCharSet(),
 393                 rFont.IsVertical(),
 394                 ITALIC_NONE != rFont.GetItalic(),
 395                 rFont.IsOutline(),
 396                 bRTL,
 397                 bBiDiStrong);
 398             // TODO: eKerning
 399
 400             const sal_Int32 nWidth(rFont.GetSize().getWidth());
 401             const sal_Int32 nHeight(rFont.GetSize().getHeight());
 402
 403             rSize.setX(nWidth ? nWidth : nHeight);
 404             rSize.setY(nHeight);
 405
 406             return aRetval;
 407         }
 408     } // end of namespace primitive2d
 409 } // end of namespace drawinglayer
 410
 411 //////////////////////////////////////////////////////////////////////////////
 412 // eof