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/TextDirection.hpp>
  39
  40 #include <vcl/metric.hxx>
  41 #include <vcl/virdev.hxx>
  42
  43 #include <basegfx/matrix/b2dhommatrix.hxx>
  44 #include <basegfx/numeric/ftools.hxx>
  45
  46 #include "impltools.hxx"
  47 #include "textlayout.hxx"
  48
  49 #include <boost/scoped_array.hpp>
  50
  51
  52 using namespace ::com::sun::star;
  53
  54 namespace vclcanvas
  55 {
  56     namespace
  57     {
  58         void setupLayoutMode( OutputDevice& rOutDev,
  59                               sal_Int8          nTextDirection )
  60         {
  61             // TODO(P3): avoid if already correctly set
  62             ULONG nLayoutMode;
  63             switch( nTextDirection )
  64             {
  65                 default:
  66                     nLayoutMode = 0;
  67                     break;
  68                 case rendering::TextDirection::WEAK_LEFT_TO_RIGHT:
  69                     nLayoutMode = TEXT_LAYOUT_BIDI_LTR;
  70                     break;
  71                 case rendering::TextDirection::STRONG_LEFT_TO_RIGHT:
  72                     nLayoutMode = TEXT_LAYOUT_BIDI_LTR | TEXT_LAYOUT_BIDI_STRONG;
  73                     break;
  74                 case rendering::TextDirection::WEAK_RIGHT_TO_LEFT:
  75                     nLayoutMode = TEXT_LAYOUT_BIDI_RTL;
  76                     break;
  77                 case rendering::TextDirection::STRONG_RIGHT_TO_LEFT:
  78                     nLayoutMode = TEXT_LAYOUT_BIDI_RTL | TEXT_LAYOUT_BIDI_STRONG;
  79                     break;
  80             }
  81
  82             // set calculated layout mode. Origin is always the left edge,
  83             // as required at the API spec
  84             rOutDev.SetLayoutMode( nLayoutMode | TEXT_LAYOUT_TEXTORIGIN_LEFT );
  85         }
  86     }
  87
  88     TextLayout::TextLayout( const rendering::StringContext&                  aText,
  89                             sal_Int8                                         nDirection,
  90                             sal_Int64                                        nRandomSeed,
  91                             const CanvasFont::Reference&                     rFont,
  92                             const uno::Reference<rendering::XGraphicDevice>& xDevice,
  93                             const OutDevProviderSharedPtr&                   rOutDev ) :
  94         TextLayout_Base( m_aMutex ),
  95         maText( aText ),
  96         maLogicalAdvancements(),
  97         mpFont( rFont ),
  98         mxDevice( xDevice ),
  99         mpOutDevProvider( rOutDev ),
 100         mnTextDirection( nDirection )
 101     {
 102         (void)nRandomSeed;
 103     }
 104
 105     void SAL_CALL TextLayout::disposing()
 106     {
 107         tools::LocalGuard aGuard;
 108
 109         mpOutDevProvider.reset();
 110         mxDevice.clear();
 111         mpFont.reset();
 112     }
 113
 114     // XTextLayout
 115     uno::Sequence< uno::Reference< rendering::XPolyPolygon2D > > SAL_CALL TextLayout::queryTextShapes(  ) throw (uno::RuntimeException)
 116     {
 117         tools::LocalGuard aGuard;
 118
 119         // TODO(F1)
 120         return uno::Sequence< uno::Reference< rendering::XPolyPolygon2D > >();
 121     }
 122
 123     uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryInkMeasures(  ) throw (uno::RuntimeException)
 124     {
 125         tools::LocalGuard aGuard;
 126
 127         // TODO(F1)
 128         return uno::Sequence< geometry::RealRectangle2D >();
 129     }
 130
 131     uno::Sequence< geometry::RealRectangle2D > SAL_CALL TextLayout::queryMeasures(  ) throw (uno::RuntimeException)
 132     {
 133         tools::LocalGuard aGuard;
 134
 135         // TODO(F1)
 136         return uno::Sequence< geometry::RealRectangle2D >();
 137     }
 138
 139     uno::Sequence< double > SAL_CALL TextLayout::queryLogicalAdvancements(  ) throw (uno::RuntimeException)
 140     {
 141         tools::LocalGuard aGuard;
 142
 143         return maLogicalAdvancements;
 144     }
 145
 146     void SAL_CALL TextLayout::applyLogicalAdvancements( const uno::Sequence< double >& aAdvancements ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 147     {
 148         tools::LocalGuard aGuard;
 149
 150         ENSURE_ARG_OR_THROW( aAdvancements.getLength() == maText.Length,
 151                          "TextLayout::applyLogicalAdvancements(): mismatching number of advancements" );
 152
 153         maLogicalAdvancements = aAdvancements;
 154     }
 155
 156     geometry::RealRectangle2D SAL_CALL TextLayout::queryTextBounds(  ) throw (uno::RuntimeException)
 157     {
 158         tools::LocalGuard aGuard;
 159
 160         if( !mpOutDevProvider )
 161             return geometry::RealRectangle2D();
 162
 163         OutputDevice& rOutDev = mpOutDevProvider->getOutDev();
 164
 165         VirtualDevice aVDev( rOutDev );
 166         aVDev.SetFont( mpFont->getVCLFont() );
 167
 168         // need metrics for Y offset, the XCanvas always renders
 169         // relative to baseline
 170         const ::FontMetric& aMetric( aVDev.GetFontMetric() );
 171
 172         setupLayoutMode( aVDev, mnTextDirection );
 173
 174         const sal_Int32 nAboveBaseline( -aMetric.GetIntLeading() - aMetric.GetAscent() );
 175         const sal_Int32 nBelowBaseline( aMetric.GetDescent() );
 176
 177         if( maLogicalAdvancements.getLength() )
 178         {
 179             return geometry::RealRectangle2D( 0, nAboveBaseline,
 180                                               maLogicalAdvancements[ maLogicalAdvancements.getLength()-1 ],
 181                                               nBelowBaseline );
 182         }
 183         else
 184         {
 185             return geometry::RealRectangle2D( 0, nAboveBaseline,
 186                                               aVDev.GetTextWidth(
 187                                                   maText.Text,
 188                                                   ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 189                                                   ::canvas::tools::numeric_cast<USHORT>(maText.Length) ),
 190                                               nBelowBaseline );
 191         }
 192     }
 193
 194     double SAL_CALL TextLayout::justify( double nSize ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 195     {
 196         tools::LocalGuard aGuard;
 197
 198         (void)nSize;
 199
 200         // TODO(F1)
 201         return 0.0;
 202     }
 203
 204     double SAL_CALL TextLayout::combinedJustify( const uno::Sequence< uno::Reference< rendering::XTextLayout > >& aNextLayouts,
 205                                                  double                                                           nSize ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 206     {
 207         tools::LocalGuard aGuard;
 208
 209         (void)aNextLayouts;
 210         (void)nSize;
 211
 212         // TODO(F1)
 213         return 0.0;
 214     }
 215
 216     rendering::TextHit SAL_CALL TextLayout::getTextHit( const geometry::RealPoint2D& aHitPoint ) throw (uno::RuntimeException)
 217     {
 218         tools::LocalGuard aGuard;
 219
 220         (void)aHitPoint;
 221
 222         // TODO(F1)
 223         return rendering::TextHit();
 224     }
 225
 226     rendering::Caret SAL_CALL TextLayout::getCaret( sal_Int32 nInsertionIndex, sal_Bool bExcludeLigatures ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 227     {
 228         tools::LocalGuard aGuard;
 229
 230         (void)nInsertionIndex;
 231         (void)bExcludeLigatures;
 232
 233         // TODO(F1)
 234         return rendering::Caret();
 235     }
 236
 237     sal_Int32 SAL_CALL TextLayout::getNextInsertionIndex( sal_Int32 nStartIndex, sal_Int32 nCaretAdvancement, sal_Bool bExcludeLigatures ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 238     {
 239         tools::LocalGuard aGuard;
 240
 241         (void)nStartIndex;
 242         (void)nCaretAdvancement;
 243         (void)bExcludeLigatures;
 244
 245         // TODO(F1)
 246         return 0;
 247     }
 248
 249     uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryVisualHighlighting( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 250     {
 251         tools::LocalGuard aGuard;
 252
 253         (void)nStartIndex;
 254         (void)nEndIndex;
 255
 256         // TODO(F1)
 257         return uno::Reference< rendering::XPolyPolygon2D >();
 258     }
 259
 260     uno::Reference< rendering::XPolyPolygon2D > SAL_CALL TextLayout::queryLogicalHighlighting( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (lang::IndexOutOfBoundsException, uno::RuntimeException)
 261     {
 262         tools::LocalGuard aGuard;
 263
 264         (void)nStartIndex;
 265         (void)nEndIndex;
 266
 267         // TODO(F1)
 268         return uno::Reference< rendering::XPolyPolygon2D >();
 269     }
 270
 271     double SAL_CALL TextLayout::getBaselineOffset(  ) throw (uno::RuntimeException)
 272     {
 273         tools::LocalGuard aGuard;
 274
 275         // TODO(F1)
 276         return 0.0;
 277     }
 278
 279     sal_Int8 SAL_CALL TextLayout::getMainTextDirection(  ) throw (uno::RuntimeException)
 280     {
 281         tools::LocalGuard aGuard;
 282
 283         return mnTextDirection;
 284     }
 285
 286     uno::Reference< rendering::XCanvasFont > SAL_CALL TextLayout::getFont(  ) throw (uno::RuntimeException)
 287     {
 288         tools::LocalGuard aGuard;
 289
 290         return mpFont.getRef();
 291     }
 292
 293     rendering::StringContext SAL_CALL TextLayout::getText(  ) throw (uno::RuntimeException)
 294     {
 295         tools::LocalGuard aGuard;
 296
 297         return maText;
 298     }
 299
 300     bool TextLayout::draw( OutputDevice&                 rOutDev,
 301                            const Point&                  rOutpos,
 302                            const rendering::ViewState&   viewState,
 303                            const rendering::RenderState& renderState ) const
 304     {
 305         tools::LocalGuard aGuard;
 306
 307         setupLayoutMode( rOutDev, mnTextDirection );
 308
 309         if( maLogicalAdvancements.getLength() )
 310         {
 311             // TODO(P2): cache that
 312             ::boost::scoped_array< sal_Int32 > aOffsets(new sal_Int32[maLogicalAdvancements.getLength()]);
 313             setupTextOffsets( aOffsets.get(), maLogicalAdvancements, viewState, renderState );
 314
 315             // TODO(F3): ensure correct length and termination for DX
 316             // array (last entry _must_ contain the overall width)
 317
 318             rOutDev.DrawTextArray( rOutpos,
 319                                    maText.Text,
 320                                    aOffsets.get(),
 321                                    ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 322                                    ::canvas::tools::numeric_cast<USHORT>(maText.Length) );
 323         }
 324         else
 325         {
 326             rOutDev.DrawText( rOutpos,
 327                               maText.Text,
 328                               ::canvas::tools::numeric_cast<USHORT>(maText.StartPosition),
 329                               ::canvas::tools::numeric_cast<USHORT>(maText.Length) );
 330         }
 331
 332         return true;
 333     }
 334
 335     namespace
 336     {
 337         class OffsetTransformer
 338         {
 339         public:
 340             OffsetTransformer( const ::basegfx::B2DHomMatrix& rMat ) :
 341                 maMatrix( rMat )
 342             {
 343             }
 344
 345             sal_Int32 operator()( const double& rOffset )
 346             {
 347                 // This is an optimization of the normal rMat*[x,0]
 348                 // transformation of the advancement vector (in x
 349                 // direction), followed by a length calculation of the
 350                 // resulting vector: advancement' =
 351                 // ||rMat*[x,0]||. Since advancements are vectors, we
 352                 // can ignore translational components, thus if [x,0],
 353                 // it follows that rMat*[x,0]=[x',0] holds. Thus, we
 354                 // just have to calc the transformation of the x
 355                 // component.
 356
 357                 // TODO(F2): Handle non-horizontal advancements!
 358                 return ::basegfx::fround( hypot(maMatrix.get(0,0)*rOffset,
 359                                                 maMatrix.get(1,0)*rOffset) );
 360             }
 361
 362         private:
 363             ::basegfx::B2DHomMatrix maMatrix;
 364         };
 365     }
 366
 367     void TextLayout::setupTextOffsets( sal_Int32*                                               outputOffsets,
 368                                        const uno::Sequence< double >&   inputOffsets,
 369                                        const rendering::ViewState&              viewState,
 370                                        const rendering::RenderState&    renderState             ) const
 371     {
 372         ENSURE_OR_THROW( outputOffsets!=NULL,
 373                           "TextLayout::setupTextOffsets offsets NULL" );
 374
 375         ::basegfx::B2DHomMatrix aMatrix;
 376
 377         ::canvas::tools::mergeViewAndRenderTransform(aMatrix,
 378                                                      viewState,
 379                                                      renderState);
 380
 381         // fill integer offsets
 382         ::std::transform( const_cast< uno::Sequence< double >& >(inputOffsets).getConstArray(),
 383                           const_cast< uno::Sequence< double >& >(inputOffsets).getConstArray()+inputOffsets.getLength(),
 384                           outputOffsets,
 385                           OffsetTransformer( aMatrix ) );
 386     }
 387
 388
 389 #define IMPLEMENTATION_NAME "VCLCanvas::TextLayout"
 390 #define SERVICE_NAME "com.sun.star.rendering.TextLayout"
 391
 392     ::rtl::OUString SAL_CALL TextLayout::getImplementationName() throw( uno::RuntimeException )
 393     {
 394         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( IMPLEMENTATION_NAME ) );
 395     }
 396
 397     sal_Bool SAL_CALL TextLayout::supportsService( const ::rtl::OUString& ServiceName ) throw( uno::RuntimeException )
 398     {
 399         return ServiceName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM ( SERVICE_NAME ) );
 400     }
 401
 402     uno::Sequence< ::rtl::OUString > SAL_CALL TextLayout::getSupportedServiceNames()  throw( uno::RuntimeException )
 403     {
 404         uno::Sequence< ::rtl::OUString > aRet(1);
 405         aRet[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM ( SERVICE_NAME ) );
 406
 407         return aRet;
 408     }
 409 }