canvas/source/vcl/textlayout.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: textlayout.cxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_canvas.hxx"
  33
  34 #include <canvas/debug.hxx>
  35 #include <tools/diagnose_ex.h>
  36 #include <canvas/canvastools.hxx>
  37
  38 #include <com/sun/star/rendering/CompositeOperation.hpp>
  39 #include <com/sun/star/rendering/TextDirection.hpp>
  40
  41 #include <vcl/metric.hxx>
  42 #include <vcl/virdev.hxx>
  43
  44 #include <basegfx/matrix/b2dhommatrix.hxx>
  45 #include <basegfx/numeric/ftools.hxx>
  46 #include <basegfx/tools/canvastools.hxx>
  47
  48 #include "impltools.hxx"
  49 #include "textlayout.hxx"
  50
  51 #include <boost/scoped_array.hpp>
  52
  53
  54 using namespace ::com::sun::star;
  55
  56 namespace vclcanvas
  57 {
  58     namespace
  59     {
  60         void setupLayoutMode( OutputDevice& rOutDev,
  61                               sal_Int8          nTextDirection )
  62         {
  63             // TODO(P3): avoid if already correctly set
  64             ULONG nLayoutMode;
  65             switch( nTextDirection )
  66             {
  67                 default:
  68                     nLayoutMode = 0;
  69                     break;
  70                 case rendering::TextDirection::WEAK_LEFT_TO_RIGHT:
  71                     nLayoutMode = TEXT_LAYOUT_BIDI_LTR;
  72                     break;
  73                 case rendering::TextDirection::STRONG_LEFT_TO_RIGHT:
  74                     nLayoutMode = TEXT_LAYOUT_BIDI_LTR | TEXT_LAYOUT_BIDI_STRONG;
  75                     break;
  76                 case rendering::TextDirection::WEAK_RIGHT_TO_LEFT:
  77                     nLayoutMode = TEXT_LAYOUT_BIDI_RTL;
  78                     break;
  79                 case rendering::TextDirection::STRONG_RIGHT_TO_LEFT:
  80                     nLayoutMode = TEXT_LAYOUT_BIDI_RTL | TEXT_LAYOUT_BIDI_STRONG;
  81                     break;
  82             }
  83
  84             // set calculated layout mode. Origin is always the left edge,
  85             // as required at the API spec
  86             rOutDev.SetLayoutMode( nLayoutMode | TEXT_LAYOUT_TEXTORIGIN_LEFT );
  87         }
  88     }
  89
  90     TextLayout::TextLayout( const rendering::StringContext&                  aText,
  91                             sal_Int8                                         nDirection,
  92                             sal_Int64                                        nRandomSeed,
  93                             const CanvasFont::Reference&                     rFont,
  94                             const uno::Reference<rendering::XGraphicDevice>& xDevice,
  95                             const OutDevProviderSharedPtr&                   rOutDev ) :
  96         TextLayout_Base( m_aMutex ),
  97         maText( aText ),
  98         maLogicalAdvancements(),
  99         mpFont( rFont ),
 100         mxDevice( xDevice ),
 101         mpOutDevProvider( rOutDev ),
 102         mnTextDirection( nDirection )
 103     {
 104         (void)nRandomSeed;
 105     }
 106
 107     void SAL_CALL TextLayout::disposing()
 108     {
 109         tools::LocalGuard aGuard;
 110
 111         mpOutDevProvider.reset();
 112         mxDevice.clear();
 113         mpFont.reset();
 114     }
 115
 116     // XTextLayout
 117     uno::Sequence< uno::Reference< rendering::XPolyPolygon2D > > SAL_CALL TextLayout::queryTextShapes(  ) throw (uno::RuntimeException)
 118     {
 119         tools::LocalGuard aGuard;
 120
 121         OutputDevice& rOutDev = mpOutDevProvider->getOutDev();
 122         VirtualDevice aVDev( rOutDev );
 123         aVDev.SetFont( mpFont->getVCLFont() );
 124
 125         setupLayoutMode( aVDev, mnTextDirection );
 126
 127         const rendering::ViewState aViewState(
 128             geometry::AffineMatrix2D(1,0,0, 0,1,0),
 129             NULL);
 130
 131         rendering::RenderState aRenderState (
 132             geometry::AffineMatrix2D(1,0,0,0,1,0),
 133             NULL,
 134             uno::Sequence<double>(4),
 135             rendering::CompositeOperation::SOURCE);
 136
 137         ::boost::scoped_array< sal_Int32 > aOffsets(new sal_Int32[maLogicalAdvancements.getLength()]);
 138         setupTextOffsets(aOffsets.get(), maLogicalAdvancements, aViewState, aRenderState);
 139
 140         uno::Sequence< uno::Reference< rendering::XPolyPolygon2D> > aOutlineSequence;
 141         ::basegfx::B2DPolyPolygonVector aOutlines;
 142         if (aVDev.GetTextOutlines(
 143             aOutlines,
 144             maText.Text,
 145             ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 146             ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 147             ::canvas::tools::numeric_cast<USHORT>(maText.Length),
 148             FALSE,
 149             0,
 150             aOffsets.get()))
 151         {
 152             aOutlineSequence.realloc(aOutlines.size());
 153             sal_Int32 nIndex (0);
 154             for (::basegfx::B2DPolyPolygonVector::const_iterator
 155                      iOutline(aOutlines.begin()),
 156                      iEnd(aOutlines.end());
 157                  iOutline!=iEnd;
 158                  ++iOutline)
 159             {
 160                 aOutlineSequence[nIndex++] = ::basegfx::unotools::xPolyPolygonFromB2DPolyPolygon(
 161                     mxDevice,
 162                     *iOutline);
 163             }
 164         }
 165
 166         return aOutlineSequence;
 167     }
 168
 169     uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryInkMeasures(  ) throw (uno::RuntimeException)
 170     {
 171         tools::LocalGuard aGuard;
 172
 173
 174         OutputDevice& rOutDev = mpOutDevProvider->getOutDev();
 175         VirtualDevice aVDev( rOutDev );
 176         aVDev.SetFont( mpFont->getVCLFont() );
 177
 178         setupLayoutMode( aVDev, mnTextDirection );
 179
 180         const rendering::ViewState aViewState(
 181             geometry::AffineMatrix2D(1,0,0, 0,1,0),
 182             NULL);
 183
 184         rendering::RenderState aRenderState (
 185             geometry::AffineMatrix2D(1,0,0,0,1,0),
 186             NULL,
 187             uno::Sequence<double>(4),
 188             rendering::CompositeOperation::SOURCE);
 189
 190         ::boost::scoped_array< sal_Int32 > aOffsets(new sal_Int32[maLogicalAdvancements.getLength()]);
 191         setupTextOffsets(aOffsets.get(), maLogicalAdvancements, aViewState, aRenderState);
 192
 193         MetricVector aMetricVector;
 194         uno::Sequence<geometry::RealRectangle2D> aBoundingBoxes;
 195         if (aVDev.GetGlyphBoundRects(
 196             Point(0,0),
 197             maText.Text,
 198             ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 199             ::canvas::tools::numeric_cast<USHORT>(maText.Length),
 200             ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 201             aMetricVector))
 202         {
 203             aBoundingBoxes.realloc(aMetricVector.size());
 204             sal_Int32 nIndex (0);
 205             for (MetricVector::const_iterator
 206                      iMetric(aMetricVector.begin()),
 207                      iEnd(aMetricVector.end());
 208                  iMetric!=iEnd;
 209                  ++iMetric)
 210             {
 211                 aBoundingBoxes[nIndex++] = geometry::RealRectangle2D(
 212                     iMetric->getX(),
 213                     iMetric->getY(),
 214                     iMetric->getX() + iMetric->getWidth(),
 215                     iMetric->getY() + iMetric->getHeight());
 216             }
 217         }
 218         return aBoundingBoxes;
 219     }
 220
 221     uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryMeasures(  ) throw (uno::RuntimeException)
 222     {
 223         tools::LocalGuard aGuard;
 224
 225         // TODO(F1)
 226         return uno::Sequence< geometry::RealRectangle2D >();
 227     }
 228
 229     uno::Sequence< double > SAL_CALL TextLayout::queryLogicalAdvancements(  ) throw (uno::RuntimeException)
 230     {
 231         tools::LocalGuard aGuard;
 232
 233         return maLogicalAdvancements;
 234     }
 235
 236     void SAL_CALL TextLayout::applyLogicalAdvancements( const uno::Sequence< double >& aAdvancements ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 237     {
 238         tools::LocalGuard aGuard;
 239
 240         ENSURE_ARG_OR_THROW( aAdvancements.getLength() == maText.Length,
 241                          "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" );
 242
 243         maLogicalAdvancements = aAdvancements;
 244     }
 245
 246     geometry::RealRectangle2D SAL_CALL TextLayout::queryTextBounds(  ) throw (uno::RuntimeException)
 247     {
 248         tools::LocalGuard aGuard;
 249
 250         if( !mpOutDevProvider )
 251             return geometry::RealRectangle2D();
 252
 253         OutputDevice& rOutDev = mpOutDevProvider->getOutDev();
 254
 255         VirtualDevice aVDev( rOutDev );
 256         aVDev.SetFont( mpFont->getVCLFont() );
 257
 258         // need metrics for Y offset, the XCanvas always renders
 259         // relative to baseline
 260         const ::FontMetric& aMetric( aVDev.GetFontMetric() );
 261
 262         setupLayoutMode( aVDev, mnTextDirection );
 263
 264         const sal_Int32 nAboveBaseline( /*-aMetric.GetIntLeading()*/ - aMetric.GetAscent() );
 265         const sal_Int32 nBelowBaseline( aMetric.GetDescent() );
 266
 267         if( maLogicalAdvancements.getLength() )
 268         {
 269             return geometry::RealRectangle2D( 0, nAboveBaseline,
 270                                               maLogicalAdvancements[ maLogicalAdvancements.getLength()-1 ],
 271                                               nBelowBaseline );
 272         }
 273         else
 274         {
 275             return geometry::RealRectangle2D( 0, nAboveBaseline,
 276                                               aVDev.GetTextWidth(
 277                                                   maText.Text,
 278                                                   ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 279                                                   ::canvas::tools::numeric_cast<USHORT>(maText.Length) ),
 280                                               nBelowBaseline );
 281         }
 282     }
 283
 284     double SAL_CALL TextLayout::justify( double nSize ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 285     {
 286         tools::LocalGuard aGuard;
 287
 288         (void)nSize;
 289
 290         // TODO(F1)
 291         return 0.0;
 292     }
 293
 294     double SAL_CALL TextLayout::combinedJustify( const uno::Sequence< uno::Reference< rendering::XTextLayout > >& aNextLayouts,
 295                                                  double                                                           nSize ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 296     {
 297         tools::LocalGuard aGuard;
 298
 299         (void)aNextLayouts;
 300         (void)nSize;
 301
 302         // TODO(F1)
 303         return 0.0;
 304     }
 305
 306     rendering::TextHit SAL_CALL TextLayout::getTextHit( const geometry::RealPoint2D& aHitPoint ) throw (uno::RuntimeException)
 307     {
 308         tools::LocalGuard aGuard;
 309
 310         (void)aHitPoint;
 311
 312         // TODO(F1)
 313         return rendering::TextHit();
 314     }
 315
 316     rendering::Caret SAL_CALL TextLayout::getCaret( sal_Int32 nInsertionIndex, sal_Bool bExcludeLigatures ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 317     {
 318         tools::LocalGuard aGuard;
 319
 320         (void)nInsertionIndex;
 321         (void)bExcludeLigatures;
 322
 323         // TODO(F1)
 324         return rendering::Caret();
 325     }
 326
 327     sal_Int32 SAL_CALL TextLayout::getNextInsertionIndex( sal_Int32 nStartIndex, sal_Int32 nCaretAdvancement, sal_Bool bExcludeLigatures ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 328     {
 329         tools::LocalGuard aGuard;
 330
 331         (void)nStartIndex;
 332         (void)nCaretAdvancement;
 333         (void)bExcludeLigatures;
 334
 335         // TODO(F1)
 336         return 0;
 337     }
 338
 339     uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryVisualHighlighting( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 340     {
 341         tools::LocalGuard aGuard;
 342
 343         (void)nStartIndex;
 344         (void)nEndIndex;
 345
 346         // TODO(F1)
 347         return uno::Reference< rendering::XPolyPolygon2D >();
 348     }
 349
 350     uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryLogicalHighlighting( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 351     {
 352         tools::LocalGuard aGuard;
 353
 354         (void)nStartIndex;
 355         (void)nEndIndex;
 356
 357         // TODO(F1)
 358         return uno::Reference< rendering::XPolyPolygon2D >();
 359     }
 360
 361     double SAL_CALL TextLayout::getBaselineOffset(  ) throw (uno::RuntimeException)
 362     {
 363         tools::LocalGuard aGuard;
 364
 365         // TODO(F1)
 366         return 0.0;
 367     }
 368
 369     sal_Int8 SAL_CALL TextLayout::getMainTextDirection(  ) throw (uno::RuntimeException)
 370     {
 371         tools::LocalGuard aGuard;
 372
 373         return mnTextDirection;
 374     }
 375
 376     uno::Reference< rendering::XCanvasFont > SAL_CALL TextLayout::getFont(  ) throw (uno::RuntimeException)
 377     {
 378         tools::LocalGuard aGuard;
 379
 380         return mpFont.getRef();
 381     }
 382
 383     rendering::StringContext SAL_CALL TextLayout::getText(  ) throw (uno::RuntimeException)
 384     {
 385         tools::LocalGuard aGuard;
 386
 387         return maText;
 388     }
 389
 390     bool TextLayout::draw( OutputDevice&                 rOutDev,
 391                            const Point&                  rOutpos,
 392                            const rendering::ViewState&   viewState,
 393                            const rendering::RenderState& renderState ) const
 394     {
 395         tools::LocalGuard aGuard;
 396
 397         setupLayoutMode( rOutDev, mnTextDirection );
 398
 399         if( maLogicalAdvancements.getLength() )
 400         {
 401             // TODO(P2): cache that
 402             ::boost::scoped_array< sal_Int32 > aOffsets(new sal_Int32[maLogicalAdvancements.getLength()]);
 403             setupTextOffsets( aOffsets.get(), maLogicalAdvancements, viewState, renderState );
 404
 405             // TODO(F3): ensure correct length and termination for DX
 406             // array (last entry _must_ contain the overall width)
 407
 408             rOutDev.DrawTextArray( rOutpos,
 409                                    maText.Text,
 410                                    aOffsets.get(),
 411                                    ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 412                                    ::canvas::tools::numeric_cast<USHORT>(maText.Length) );
 413         }
 414         else
 415         {
 416             rOutDev.DrawText( rOutpos,
 417                               maText.Text,
 418                               ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 419                               ::canvas::tools::numeric_cast<USHORT>(maText.Length) );
 420         }
 421
 422         return true;
 423     }
 424
 425     namespace
 426     {
 427         class OffsetTransformer
 428         {
 429         public:
 430             OffsetTransformer( const ::basegfx::B2DHomMatrix& rMat ) :
 431                 maMatrix( rMat )
 432             {
 433             }
 434
 435             sal_Int32 operator()( const double& rOffset )
 436             {
 437                 // This is an optimization of the normal rMat*[x,0]
 438                 // transformation of the advancement vector (in x
 439                 // direction), followed by a length calculation of the
 440                 // resulting vector: advancement' =
 441                 // ||rMat*[x,0]||. Since advancements are vectors, we
 442                 // can ignore translational components, thus if [x,0],
 443                 // it follows that rMat*[x,0]=[x',0] holds. Thus, we
 444                 // just have to calc the transformation of the x
 445                 // component.
 446
 447                 // TODO(F2): Handle non-horizontal advancements!
 448                 return ::basegfx::fround( hypot(maMatrix.get(0,0)*rOffset,
 449                                                 maMatrix.get(1,0)*rOffset) );
 450             }
 451
 452         private:
 453             ::basegfx::B2DHomMatrix maMatrix;
 454         };
 455     }
 456
 457     void TextLayout::setupTextOffsets( sal_Int32*                                               outputOffsets,
 458                                        const uno::Sequence< double >&   inputOffsets,
 459                                        const rendering::ViewState&              viewState,
 460                                        const rendering::RenderState&    renderState             ) const
 461     {
 462         ENSURE_OR_THROW( outputOffsets!=NULL,
 463                           "TextLayout::setupTextOffsets offsets NULL" );
 464
 465         ::basegfx::B2DHomMatrix aMatrix;
 466
 467         ::canvas::tools::mergeViewAndRenderTransform(aMatrix,
 468                                                      viewState,
 469                                                      renderState);
 470
 471         // fill integer offsets
 472         ::std::transform( const_cast< uno::Sequence< double >& >(inputOffsets).getConstArray(),
 473                           const_cast< uno::Sequence< double >& >(inputOffsets).getConstArray()+inputOffsets.getLength(),
 474                           outputOffsets,
 475                           OffsetTransformer( aMatrix ) );
 476     }
 477
 478
 479 #define IMPLEMENTATION_NAME "VCLCanvas::TextLayout"
 480 #define SERVICE_NAME "com.sun.star.rendering.TextLayout"
 481
 482     ::rtl::OUString SAL_CALL TextLayout::getImplementationName() throw( uno::RuntimeException )
 483     {
 484         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( IMPLEMENTATION_NAME ) );
 485     }
 486
 487     sal_Bool SAL_CALL TextLayout::supportsService( const ::rtl::OUString& ServiceName ) throw( uno::RuntimeException )
 488     {
 489         return ServiceName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM ( SERVICE_NAME ) );
 490     }
 491
 492     uno::Sequence< ::rtl::OUString > SAL_CALL TextLayout::getSupportedServiceNames()  throw( uno::RuntimeException )
 493     {
 494         uno::Sequence< ::rtl::OUString > aRet(1);
 495         aRet[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM ( SERVICE_NAME ) );
 496
 497         return aRet;
 498     }
 499 }