editeng/source/uno/unonrule.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 <sal/config.h>
  21
  22 #include <com/sun/star/awt/FontDescriptor.hpp>
  23 #include <com/sun/star/beans/PropertyValue.hpp>
  24 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <com/sun/star/text/HoriOrientation.hpp>
  27 #include <com/sun/star/awt/XBitmap.hpp>
  28 #include <com/sun/star/graphic/XGraphic.hpp>
  29 #include <cppuhelper/supportsservice.hxx>
  30 #include <cppuhelper/implbase1.hxx>
  31 #include <utility>
  32 #include <vcl/font.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include <vcl/graph.hxx>
  35 #include <vcl/GraphicObject.hxx>
  36 #include <vcl/GraphicLoader.hxx>
  37 #include <tools/debug.hxx>
  38
  39 #include <editeng/brushitem.hxx>
  40 #include <editeng/unoprnms.hxx>
  41 #include <editeng/numitem.hxx>
  42 #include <editeng/unofdesc.hxx>
  43 #include <editeng/unonrule.hxx>
  44 #include <editeng/editids.hrc>
  45 #include <o3tl/enumarray.hxx>
  46 #include <o3tl/temporary.hxx>
  47 #include <memory>
  48
  49 using ::com::sun::star::util::XCloneable;
  50 using ::com::sun::star::ucb::XAnyCompare;
  51
  52
  53 using namespace ::com::sun::star;
  54 using namespace ::com::sun::star::uno;
  55 using namespace ::com::sun::star::lang;
  56 using namespace ::com::sun::star::container;
  57
  58 const SvxAdjust aUnoToSvxAdjust[] =
  59 {
  60     SvxAdjust::Left,
  61     SvxAdjust::Right,
  62     SvxAdjust::Center,
  63     SvxAdjust::Left,
  64     SvxAdjust::Left,
  65     SvxAdjust::Left,
  66     SvxAdjust::Block
  67 };
  68
  69 const o3tl::enumarray<SvxAdjust, sal_Int16> aSvxToUnoAdjust
  70 {
  71     text::HoriOrientation::LEFT,
  72     text::HoriOrientation::RIGHT,
  73     text::HoriOrientation::FULL,
  74     text::HoriOrientation::CENTER,
  75     text::HoriOrientation::FULL,
  76     text::HoriOrientation::LEFT
  77 };
  78
  79 static SvxAdjust ConvertUnoAdjust( unsigned short nAdjust )
  80 {
  81     DBG_ASSERT( nAdjust <= 7, "Enum has changed! [CL]" );
  82     return aUnoToSvxAdjust[nAdjust];
  83 }
  84
  85 static unsigned short ConvertUnoAdjust( SvxAdjust eAdjust )
  86 {
  87     DBG_ASSERT( static_cast<int>(eAdjust) <= 6, "Enum has changed! [CL]" );
  88     return aSvxToUnoAdjust[eAdjust];
  89 }
  90
  91 SvxUnoNumberingRules::SvxUnoNumberingRules(SvxNumRule aRule)
  92 : maRule(std::move( aRule ))
  93 {
  94 }
  95
  96 SvxUnoNumberingRules::~SvxUnoNumberingRules() noexcept
  97 {
  98 }
  99
 100 //XIndexReplace
 101 void SAL_CALL SvxUnoNumberingRules::replaceByIndex( sal_Int32 Index, const uno::Any& Element )
 102 {
 103     SolarMutexGuard aGuard;
 104
 105     if( Index < 0 || Index >= maRule.GetLevelCount() )
 106         throw IndexOutOfBoundsException();
 107
 108     Sequence< beans::PropertyValue > aSeq;
 109
 110     if( !( Element >>= aSeq) )
 111         throw IllegalArgumentException();
 112     setNumberingRuleByIndex( aSeq, Index );
 113 }
 114
 115 // XIndexAccess
 116 sal_Int32 SAL_CALL SvxUnoNumberingRules::getCount()
 117 {
 118     SolarMutexGuard aGuard;
 119
 120     return maRule.GetLevelCount();
 121 }
 122
 123 Any SAL_CALL SvxUnoNumberingRules::getByIndex( sal_Int32 Index )
 124 {
 125     SolarMutexGuard aGuard;
 126
 127     if( Index < 0 || Index >= maRule.GetLevelCount() )
 128         throw IndexOutOfBoundsException();
 129
 130     return Any( getNumberingRuleByIndex(Index) );
 131 }
 132
 133 //XElementAccess
 134 Type SAL_CALL SvxUnoNumberingRules::getElementType()
 135 {
 136     return cppu::UnoType<Sequence< beans::PropertyValue >>::get();
 137 }
 138
 139 sal_Bool SAL_CALL SvxUnoNumberingRules::hasElements()
 140 {
 141     return true;
 142 }
 143
 144 // XAnyCompare
 145 sal_Int16 SAL_CALL SvxUnoNumberingRules::compare( const Any& rAny1, const Any& rAny2 )
 146 {
 147     return SvxUnoNumberingRules::Compare( rAny1, rAny2 );
 148 }
 149
 150 // XCloneable
 151 Reference< XCloneable > SAL_CALL SvxUnoNumberingRules::createClone(  )
 152 {
 153     return new SvxUnoNumberingRules(maRule);
 154 }
 155
 156 OUString SAL_CALL SvxUnoNumberingRules::getImplementationName(  )
 157 {
 158     return u"SvxUnoNumberingRules"_ustr;
 159 }
 160
 161 sal_Bool SAL_CALL SvxUnoNumberingRules::supportsService( const OUString& ServiceName )
 162 {
 163     return cppu::supportsService(this, ServiceName);
 164 }
 165
 166 Sequence< OUString > SAL_CALL SvxUnoNumberingRules::getSupportedServiceNames(  )
 167 {
 168     return { u"com.sun.star.text.NumberingRules"_ustr };
 169 }
 170
 171 Sequence<beans::PropertyValue> SvxUnoNumberingRules::getNumberingRuleByIndex(sal_Int32 nIndex) const
 172 {
 173     //  NumberingRule aRule;
 174     const SvxNumberFormat& rFmt = maRule.GetLevel(static_cast<sal_uInt16>(nIndex));
 175     sal_uInt16 nIdx = 0;
 176
 177     const int nProps = 15;
 178     std::unique_ptr<beans::PropertyValue[]> pArray(new beans::PropertyValue[nProps]);
 179
 180     Any aVal;
 181     {
 182         aVal <<= static_cast<sal_uInt16>(rFmt.GetNumberingType());
 183         pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_NUMBERINGTYPE, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 184     }
 185
 186     {
 187         SvxAdjust eAdj = rFmt.GetNumAdjust();
 188         aVal <<= ConvertUnoAdjust(eAdj);
 189         pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_ADJUST, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 190     }
 191
 192     {
 193         aVal <<= rFmt.GetPrefix();
 194         pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_PREFIX, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 195     }
 196
 197     {
 198         aVal <<= rFmt.GetSuffix();
 199         pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_SUFFIX, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 200     }
 201
 202     if(SVX_NUM_CHAR_SPECIAL == rFmt.GetNumberingType())
 203     {
 204         sal_UCS4 nCode = rFmt.GetBulletChar();
 205         OUString aStr( &nCode, 1 );
 206         aVal <<= aStr;
 207         pArray[nIdx++] = beans::PropertyValue(u"BulletChar"_ustr, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 208     }
 209
 210     if( rFmt.GetBulletFont() )
 211     {
 212         awt::FontDescriptor aDesc;
 213         SvxUnoFontDescriptor::ConvertFromFont( *rFmt.GetBulletFont(), aDesc );
 214         aVal <<= aDesc;
 215         pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_BULLET_FONT, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 216     }
 217
 218     {
 219         const SvxBrushItem* pBrush = rFmt.GetBrush();
 220         const Graphic* pGraphic = nullptr;
 221         if (pBrush)
 222             pGraphic = pBrush->GetGraphic();
 223         if (pGraphic)
 224         {
 225             uno::Reference<awt::XBitmap> xBitmap(pGraphic->GetXGraphic(), uno::UNO_QUERY);
 226             aVal <<= xBitmap;
 227
 228             pArray[nIdx++] = beans::PropertyValue(u"GraphicBitmap"_ustr, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 229         }
 230     }
 231
 232     {
 233         const Size aSize( rFmt.GetGraphicSize() );
 234         const awt::Size aUnoSize( aSize.Width(), aSize.Height() );
 235         aVal <<= aUnoSize;
 236         pArray[nIdx++] = beans::PropertyValue(u"GraphicSize"_ustr, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 237     }
 238
 239     aVal <<= static_cast<sal_Int16>(rFmt.GetStart());
 240     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_START_WITH, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 241
 242     aVal <<= rFmt.GetAbsLSpace();
 243     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_LEFT_MARGIN, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 244
 245     aVal <<= rFmt.GetFirstLineOffset();
 246     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_FIRST_LINE_OFFSET, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 247
 248     pArray[nIdx++] = beans::PropertyValue(u"SymbolTextDistance"_ustr, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 249
 250     aVal <<= rFmt.GetBulletColor();
 251     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_BULLET_COLOR, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 252
 253     aVal <<= static_cast<sal_Int16>(rFmt.GetBulletRelSize());
 254     pArray[nIdx++] = beans::PropertyValue(UNO_NAME_NRULE_BULLET_RELSIZE, -1, aVal, beans::PropertyState_DIRECT_VALUE);
 255
 256     DBG_ASSERT( nIdx <= nProps, "FixMe: overflow in Array!!! [CL]" );
 257     Sequence< beans::PropertyValue> aSeq(pArray.get(), nIdx);
 258
 259     return aSeq;
 260 }
 261
 262 void SvxUnoNumberingRules::setNumberingRuleByIndex(const Sequence<beans::PropertyValue >& rProperties, sal_Int32 nIndex)
 263 {
 264     SvxNumberFormat aFmt(maRule.GetLevel( static_cast<sal_uInt16>(nIndex) ));
 265     for(const beans::PropertyValue& rProp : rProperties)
 266     {
 267         const OUString& rPropName = rProp.Name;
 268         const Any& aVal = rProp.Value;
 269
 270         if ( rPropName == UNO_NAME_NRULE_NUMBERINGTYPE )
 271         {
 272             sal_Int16 nSet = sal_Int16();
 273             aVal >>= nSet;
 274
 275             // There is no reason to limit numbering types.
 276             if ( nSet>=0 )
 277             {
 278                 aFmt.SetNumberingType(static_cast<SvxNumType>(nSet));
 279                 continue;
 280             }
 281         }
 282         else if ( rPropName == UNO_NAME_NRULE_PREFIX )
 283         {
 284             OUString aPrefix;
 285             if( aVal >>= aPrefix )
 286             {
 287                 aFmt.SetPrefix(aPrefix);
 288                 continue;
 289             }
 290         }
 291         else if ( rPropName == UNO_NAME_NRULE_SUFFIX )
 292         {
 293             OUString aSuffix;
 294             if( aVal >>= aSuffix )
 295             {
 296                 aFmt.SetSuffix(aSuffix);
 297                 continue;
 298             }
 299         }
 300         else if ( rPropName == UNO_NAME_NRULE_BULLETID )
 301         {
 302             sal_Int16 nSet = sal_Int16();
 303             if( aVal >>= nSet )
 304             {
 305                 if(nSet < 0x100)
 306                 {
 307                     aFmt.SetBulletChar(nSet);
 308                     continue;
 309                 }
 310             }
 311         }
 312         else if ( rPropName == "BulletChar" )
 313         {
 314             OUString aStr;
 315             if( aVal >>= aStr )
 316             {
 317                 if(!aStr.isEmpty())
 318                 {
 319                     aFmt.SetBulletChar(aStr.iterateCodePoints(&o3tl::temporary(sal_Int32(0))));
 320                 }
 321                 else
 322                 {
 323                     aFmt.SetBulletChar(0);
 324                 }
 325                 continue;
 326             }
 327         }
 328         else if ( rPropName == UNO_NAME_NRULE_ADJUST )
 329         {
 330             sal_Int16 nAdjust = sal_Int16();
 331             if( aVal >>= nAdjust )
 332             {
 333                 aFmt.SetNumAdjust(ConvertUnoAdjust( static_cast<unsigned short>(nAdjust) ));
 334                 continue;
 335             }
 336         }
 337         else if ( rPropName == UNO_NAME_NRULE_BULLET_FONT )
 338         {
 339             awt::FontDescriptor aDesc;
 340             if( aVal >>= aDesc )
 341             {
 342                 vcl::Font aFont;
 343                 SvxUnoFontDescriptor::ConvertToFont( aDesc, aFont );
 344                 aFmt.SetBulletFont(&aFont);
 345                 continue;
 346             }
 347         }
 348         else if ( rPropName == "GraphicURL" )
 349         {
 350             OUString aURL;
 351             if (aVal >>= aURL)
 352             {
 353                 Graphic aGraphic = vcl::graphic::loadFromURL(aURL);
 354                 if (!aGraphic.IsNone())
 355                 {
 356                     SvxBrushItem aBrushItem(aGraphic, GPOS_AREA, SID_ATTR_BRUSH);
 357                     aFmt.SetGraphicBrush(&aBrushItem);
 358                 }
 359                 continue;
 360             }
 361         }
 362         else if ( rPropName == "GraphicBitmap" )
 363         {
 364             uno::Reference<awt::XBitmap> xBitmap;
 365             if (aVal >>= xBitmap)
 366             {
 367                 uno::Reference<graphic::XGraphic> xGraphic(xBitmap, uno::UNO_QUERY);
 368                 Graphic aGraphic(xGraphic);
 369                 SvxBrushItem aBrushItem(aGraphic, GPOS_AREA, SID_ATTR_BRUSH);
 370                 aFmt.SetGraphicBrush( &aBrushItem );
 371                 continue;
 372             }
 373         }
 374         else if ( rPropName == "GraphicSize" )
 375         {
 376             awt::Size aUnoSize;
 377             if( aVal >>= aUnoSize )
 378             {
 379                 aFmt.SetGraphicSize( Size( aUnoSize.Width, aUnoSize.Height ) );
 380                 continue;
 381             }
 382         }
 383         else if ( rPropName == UNO_NAME_NRULE_START_WITH )
 384         {
 385             sal_Int16 nStart = sal_Int16();
 386             if( aVal >>= nStart )
 387             {
 388                 aFmt.SetStart( nStart );
 389                 continue;
 390             }
 391         }
 392         else if ( rPropName == UNO_NAME_NRULE_LEFT_MARGIN )
 393         {
 394             sal_Int32 nMargin = 0;
 395             if( aVal >>= nMargin )
 396             {
 397                 aFmt.SetAbsLSpace(nMargin);
 398                 continue;
 399             }
 400         }
 401         else if ( rPropName == UNO_NAME_NRULE_FIRST_LINE_OFFSET )
 402         {
 403             sal_Int32 nMargin = 0;
 404             if( aVal >>= nMargin )
 405             {
 406                 aFmt.SetFirstLineOffset(nMargin);
 407                 continue;
 408             }
 409         }
 410         else if ( rPropName == "SymbolTextDistance" )
 411         {
 412             sal_Int32 nTextDistance = 0;
 413             if( aVal >>= nTextDistance )
 414             {
 415                 aFmt.SetCharTextDistance(static_cast<sal_uInt16>(nTextDistance));
 416                 continue;
 417             }
 418         }
 419         else if ( rPropName == UNO_NAME_NRULE_BULLET_COLOR )
 420         {
 421             Color aColor;
 422             if( aVal >>= aColor )
 423             {
 424                 aFmt.SetBulletColor( aColor );
 425                 continue;
 426             }
 427         }
 428         else if ( rPropName == UNO_NAME_NRULE_BULLET_RELSIZE )
 429         {
 430             sal_Int16 nSize = sal_Int16();
 431             if( aVal >>= nSize )
 432             {
 433                 // [AOO Bug 120650] the slide content corrupt when open in Aoo
 434                 // [TDF# 126234] when MS Office document being imported, the value of the relative size
 435                 // of the bullet could be as high as 400%
 436                 if ((nSize>400)||(nSize<=0))
 437                 {
 438                     nSize = 100;
 439                 }
 440
 441                 aFmt.SetBulletRelSize( static_cast<short>(nSize) );
 442                 continue;
 443             }
 444         }
 445         else
 446         {
 447             continue;
 448         }
 449
 450         throw IllegalArgumentException();
 451     }
 452
 453     // check that we always have a brush item for bitmap numbering
 454     if( aFmt.GetNumberingType() == SVX_NUM_BITMAP )
 455     {
 456         if( nullptr == aFmt.GetBrush() )
 457         {
 458             GraphicObject aGrafObj;
 459             SvxBrushItem aBrushItem( aGrafObj, GPOS_AREA, SID_ATTR_BRUSH );
 460             aFmt.SetGraphicBrush( &aBrushItem );
 461         }
 462     }
 463     maRule.SetLevel( static_cast<sal_uInt16>(nIndex), aFmt );
 464 }
 465
 466 const SvxNumRule& SvxGetNumRule( Reference< XIndexReplace > const & xRule )
 467 {
 468     SvxUnoNumberingRules* pRule = dynamic_cast<SvxUnoNumberingRules*>( xRule.get() );
 469     if( pRule == nullptr )
 470         throw IllegalArgumentException();
 471
 472     return pRule->getNumRule();
 473 }
 474
 475 css::uno::Reference< css::container::XIndexReplace > SvxCreateNumRule(const SvxNumRule& rRule)
 476 {
 477     return new SvxUnoNumberingRules( rRule );
 478 }
 479
 480 namespace {
 481
 482 class SvxUnoNumberingRulesCompare : public ::cppu::WeakImplHelper< XAnyCompare >
 483 {
 484 public:
 485     virtual sal_Int16 SAL_CALL compare( const Any& Any1, const Any& Any2 ) override;
 486 };
 487
 488 }
 489
 490 sal_Int16 SAL_CALL SvxUnoNumberingRulesCompare::compare( const Any& Any1, const Any& Any2 )
 491 {
 492     return SvxUnoNumberingRules::Compare( Any1, Any2 );
 493 }
 494
 495 sal_Int16 SvxUnoNumberingRules::Compare( const Any& Any1, const Any& Any2 )
 496 {
 497     Reference< XIndexReplace > x1( Any1, UNO_QUERY ), x2( Any2, UNO_QUERY );
 498     if( !x1 || !x2 )
 499         return -1;
 500
 501     if( x1.get() == x2.get() )
 502         return 0;
 503
 504     SvxUnoNumberingRules* pRule1 = dynamic_cast<SvxUnoNumberingRules*>( x1.get() );
 505     if( !pRule1 )
 506         return -1;
 507     SvxUnoNumberingRules* pRule2 = dynamic_cast<SvxUnoNumberingRules*>( x2.get() );
 508     if( !pRule2 )
 509         return -1;
 510
 511     const SvxNumRule& rRule1 = pRule1->getNumRule();
 512     const SvxNumRule& rRule2 = pRule2->getNumRule();
 513
 514     const sal_uInt16 nLevelCount1 = rRule1.GetLevelCount();
 515     const sal_uInt16 nLevelCount2 = rRule2.GetLevelCount();
 516
 517     if( nLevelCount1 == 0 || nLevelCount2 == 0 )
 518         return -1;
 519
 520     for( sal_uInt16 i = 0; (i < nLevelCount1) && (i < nLevelCount2); i++ )
 521     {
 522         if( rRule1.GetLevel(i) != rRule2.GetLevel(i) )
 523             return -1;
 524     }
 525     return  0;
 526 }
 527
 528 Reference< XAnyCompare > SvxCreateNumRuleCompare() noexcept
 529 {
 530     return new SvxUnoNumberingRulesCompare;
 531 }
 532
 533 css::uno::Reference< css::container::XIndexReplace > SvxCreateNumRule()
 534 {
 535     SvxNumRule aTempRule( SvxNumRuleFlags::NONE, 10, false );
 536     return SvxCreateNumRule( aTempRule );
 537 }
 538
 539 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */