filter/source/msfilter/mstoolbar.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
  10 #include <sal/config.h>
  11
  12 #include <comphelper/propertyvalue.hxx>
  13 #include <filter/msfilter/mstoolbar.hxx>
  14 #include <o3tl/safeint.hxx>
  15 #include <sal/log.hxx>
  16 #include <com/sun/star/beans/XPropertySet.hpp>
  17 #include <com/sun/star/container/XIndexContainer.hpp>
  18 #include <com/sun/star/frame/XModel.hpp>
  19 #include <com/sun/star/ui/XUIConfigurationManager.hpp>
  20 #include <com/sun/star/ui/XUIConfigurationManagerSupplier.hpp>
  21 #include <com/sun/star/ui/XUIConfigurationPersistence.hpp>
  22 #include <com/sun/star/ui/XImageManager.hpp>
  23 #include <com/sun/star/ui/ImageType.hpp>
  24 #include <com/sun/star/ui/ItemType.hpp>
  25 #include <com/sun/star/ui/ItemStyle.hpp>
  26 #include <utility>
  27 #include <vcl/dibtools.hxx>
  28 #include <vcl/graph.hxx>
  29 #include <vcl/bitmapex.hxx>
  30 #include <sfx2/objsh.hxx>
  31 #include <filter/msfilter/msvbahelper.hxx>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/window.hxx>
  34
  35 using namespace com::sun::star;
  36
  37 int TBBase::nIndent = 0;
  38
  39 void CustomToolBarImportHelper::ScaleImage( uno::Reference< graphic::XGraphic >& xGraphic, tools::Long nNewSize )
  40 {
  41     Graphic aGraphic( xGraphic );
  42     Size aSize = aGraphic.GetSizePixel();
  43     if ( aSize.Height() && ( aSize.Height() == aSize.Width() ) )
  44     {
  45         Graphic aImage(xGraphic);
  46         if ( aSize.Height() != nNewSize )
  47         {
  48             BitmapEx aBitmap = aImage.GetBitmapEx();
  49             BitmapEx aBitmapex = BitmapEx::AutoScaleBitmap(aBitmap, nNewSize );
  50             aImage = Graphic(aBitmapex);
  51             xGraphic = aImage.GetXGraphic();
  52         }
  53     }
  54 }
  55
  56 void CustomToolBarImportHelper::applyIcons()
  57 {
  58     for (auto const& concommand : iconcommands)
  59     {
  60         uno::Sequence<OUString> commands { concommand.sCommand };
  61         uno::Sequence< uno::Reference< graphic::XGraphic > > images { concommand.image };
  62         auto pimages = images.getArray();
  63
  64         uno::Reference< ui::XImageManager > xImageManager( getCfgManager()->getImageManager(), uno::UNO_QUERY_THROW );
  65         sal_uInt16 nColor = ui::ImageType::COLOR_NORMAL;
  66
  67         vcl::Window* topwin = Application::GetActiveTopWindow();
  68         if ( topwin != nullptr && topwin->GetBackgroundColor().IsDark() )
  69                 nColor = css::ui::ImageType::COLOR_HIGHCONTRAST;
  70
  71         ScaleImage( pimages[ 0 ], 16 );
  72         xImageManager->replaceImages( ui::ImageType::SIZE_DEFAULT | nColor,  commands, images );
  73         ScaleImage( pimages[ 0 ], 26 );
  74         xImageManager->replaceImages( ui::ImageType::SIZE_LARGE | nColor,  commands, images );
  75     }
  76 }
  77
  78 void CustomToolBarImportHelper::addIcon( const uno::Reference< graphic::XGraphic >& xImage, const OUString& sString )
  79 {
  80     iconcontrolitem item;
  81     item.sCommand = sString;
  82     item.image = xImage;
  83     iconcommands.push_back( item );
  84 }
  85
  86 CustomToolBarImportHelper::CustomToolBarImportHelper( SfxObjectShell& rDocShell,  const css::uno::Reference< css::ui::XUIConfigurationManager>& rxAppCfgMgr ) : mrDocSh( rDocShell )
  87 {
  88     m_xCfgSupp.set( mrDocSh.GetModel(), uno::UNO_QUERY_THROW );
  89     m_xAppCfgMgr.set( rxAppCfgMgr, uno::UNO_SET_THROW );
  90 }
  91
  92 uno::Reference< ui::XUIConfigurationManager >
  93 CustomToolBarImportHelper::getCfgManager()
  94 {
  95     return m_xCfgSupp->getUIConfigurationManager();
  96 }
  97
  98
  99 uno::Any
 100 CustomToolBarImportHelper::createCommandFromMacro( std::u16string_view sCmd )
 101 {
 102     //"vnd.sun.star.script:Standard.Module1.Main?language=Basic&location=document"
 103     // create script url
 104     OUString scriptURL
 105         = OUString::Concat("vnd.sun.star.script:") + sCmd + "?language=Basic&location=document";
 106     return uno::Any( scriptURL );
 107 }
 108
 109 OUString CustomToolBarImportHelper::MSOCommandToOOCommand( sal_Int16 msoCmd )
 110 {
 111     OUString result;
 112     if (pMSOCmdConvertor)
 113         result = pMSOCmdConvertor->MSOCommandToOOCommand( msoCmd );
 114     return result;
 115 }
 116
 117 OUString CustomToolBarImportHelper::MSOTCIDToOOCommand( sal_Int16 msoTCID )
 118 {
 119     OUString result;
 120     if (pMSOCmdConvertor)
 121         result = pMSOCmdConvertor->MSOTCIDToOOCommand( msoTCID );
 122     return result;
 123 }
 124
 125 bool
 126 CustomToolBarImportHelper::createMenu( const OUString& rName, const uno::Reference< container::XIndexAccess >& xMenuDesc )
 127 {
 128     bool bRes = true;
 129     try
 130     {
 131         uno::Reference< ui::XUIConfigurationManager > xCfgManager( getCfgManager() );
 132         OUString sMenuBar = "private:resource/menubar/" + rName;
 133         uno::Reference< container::XIndexContainer > xPopup( xCfgManager->createSettings(), uno::UNO_SET_THROW );
 134         uno::Reference< beans::XPropertySet > xProps( xPopup, uno::UNO_QUERY_THROW );
 135         // set name for menubar
 136         xProps->setPropertyValue("UIName", uno::Any( rName ) );
 137         if ( xPopup.is() )
 138         {
 139             uno::Sequence< beans::PropertyValue > aPopupMenu{
 140                 comphelper::makePropertyValue("CommandURL", "vnd.openoffice.org:" + rName),
 141                 comphelper::makePropertyValue("Label", rName),
 142                 comphelper::makePropertyValue("ItemDescriptorContainer", xMenuDesc),
 143                 comphelper::makePropertyValue("Type", sal_Int32( 0 ))
 144             };
 145
 146             xPopup->insertByIndex( xPopup->getCount(), uno::Any( aPopupMenu ) );
 147             xCfgManager->insertSettings( sMenuBar, xPopup );
 148             uno::Reference< ui::XUIConfigurationPersistence > xPersistence( xCfgManager, uno::UNO_QUERY_THROW );
 149             xPersistence->store();
 150         }
 151     }
 152     catch( const uno::Exception& )
 153     {
 154         bRes = false;
 155     }
 156     return bRes;
 157 }
 158
 159 #ifdef DEBUG_FILTER_MSTOOLBAR
 160 void TBBase::indent_printf( FILE* fp, const char* format, ... )
 161 {
 162    va_list ap;
 163    va_start ( ap, format );
 164
 165    // indent nIndent spaces
 166    for ( int i=0; i<nIndent; ++i)
 167       fprintf(fp," ");
 168    // append the rest of the message
 169    vfprintf( fp, format, ap );
 170    va_end( ap );
 171 }
 172 #endif
 173
 174 TBCHeader::TBCHeader()
 175     : bSignature(0x3)
 176     , bVersion(0x01)
 177     , bFlagsTCR(0)
 178     , tct(0x1) // default to Button
 179     , tcid(0)
 180     , tbct(0)
 181     , bPriority(0)
 182 {
 183 }
 184
 185 TBCHeader::~TBCHeader()
 186 {
 187 }
 188
 189 bool TBCHeader::Read( SvStream &rS )
 190 {
 191     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 192     nOffSet = rS.Tell();
 193     rS.ReadSChar( bSignature ).ReadSChar( bVersion ).ReadUChar( bFlagsTCR ).ReadUChar( tct ).ReadUInt16( tcid ).ReadUInt32( tbct ).ReadUChar( bPriority );
 194     //  bit 4 ( from lsb )
 195     if ( bFlagsTCR & 0x10 )
 196     {
 197         width = std::make_shared<sal_uInt16>();
 198         height = std::make_shared<sal_uInt16>();
 199         rS.ReadUInt16( *width ).ReadUInt16( *height );
 200     }
 201     return true;
 202 }
 203
 204 #ifdef DEBUG_FILTER_MSTOOLBAR
 205 void TBCHeader::Print( FILE* fp )
 206 {
 207     Indent a;
 208     indent_printf(fp,"[ 0x%x ] TBCHeader -- dump\n", nOffSet );
 209     indent_printf(fp,"  bSignature 0x%x\n", bSignature );
 210     indent_printf(fp,"  bVersion 0x%x\n", bVersion );
 211     indent_printf(fp,"  bFlagsTCR 0x%x\n", bFlagsTCR );
 212     indent_printf(fp,"  tct 0x%x\n", tct );
 213     indent_printf(fp,"  tcid 0x%x\n", tcid );
 214     indent_printf(fp,"  tbct 0x%x\n", static_cast< unsigned int >( tbct ));
 215     indent_printf(fp,"  bPriority 0x%x\n", bPriority );
 216     if ( width.get() )
 217         indent_printf(fp,"  width %d(0x%x)\n", *width, *width);
 218     if ( height.get() )
 219         indent_printf(fp,"  height %d(0x%x)\n", *height, *height);
 220 }
 221 #endif
 222
 223 TBCData::TBCData( TBCHeader Header ) : rHeader(std::move( Header ))
 224 {
 225 }
 226
 227 bool TBCData::Read(SvStream &rS)
 228 {
 229     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 230     nOffSet = rS.Tell();
 231     if ( !controlGeneralInfo.Read(rS) /*|| !controlSpecificInfo.Read(rS)*/ )
 232         return false;
 233     switch ( rHeader.getTct() )
 234     {
 235         case 0x01: // (Button control)
 236         case 0x10: // (ExpandingGrid control)
 237             controlSpecificInfo = std::make_shared<TBCBSpecific>();
 238             break;
 239         case 0x0A: // (Popup control)
 240         case 0x0C: // (ButtonPopup control)
 241         case 0x0D: // (SplitButtonPopup control)
 242         case 0x0E: // (SplitButtonMRUPopup control)
 243             controlSpecificInfo = std::make_shared<TBCMenuSpecific>();
 244             break;
 245         case 0x02: // (Edit control)
 246         case 0x04: // (ComboBox control)
 247         case 0x14: // (GraphicCombo control)
 248         case 0x03: // (DropDown control)
 249         case 0x06: // (SplitDropDown control)
 250         case 0x09: // (GraphicDropDown control)
 251             controlSpecificInfo = std::make_shared<TBCComboDropdownSpecific>( rHeader );
 252             break;
 253         default:
 254             break;
 255     }
 256     if ( controlSpecificInfo )
 257         return controlSpecificInfo->Read( rS );
 258     //#FIXME I need to be able to handle different controlSpecificInfo types.
 259     return true;
 260 }
 261
 262 TBCMenuSpecific* TBCData::getMenuSpecific()
 263 {
 264     TBCMenuSpecific* pMenu = dynamic_cast< TBCMenuSpecific* >( controlSpecificInfo.get() );
 265     return pMenu;
 266 }
 267 void TBCData::ImportToolBarControl( CustomToolBarImportHelper& helper, std::vector< css::beans::PropertyValue >& props, bool& bBeginGroup, bool bIsMenuBar )
 268 {
 269     sal_uInt16  nStyle = 0;
 270     bBeginGroup = rHeader.isBeginGroup();
 271     controlGeneralInfo.ImportToolBarControlData( helper, props );
 272     beans::PropertyValue aProp;
 273     aProp.Name = "Visible";
 274     aProp.Value <<= rHeader.isVisible(); // where is the visible attribute stored
 275     props.push_back( aProp );
 276     if ( rHeader.getTct() == 0x01
 277     || rHeader.getTct() == 0x10 )
 278     {
 279         TBCBSpecific* pSpecificInfo = dynamic_cast< TBCBSpecific* >( controlSpecificInfo.get() );
 280         if ( pSpecificInfo )
 281         {
 282             // if we have an icon then lets set it for the command
 283             OUString sCommand;
 284             for (auto const& property : props)
 285             {
 286                 // TODO JNA : couldn't we break if we find CommandURL to avoid keeping on the loop?
 287                 if ( property.Name == "CommandURL" )
 288                     property.Value >>= sCommand;
 289             }
 290             if ( TBCBitMap* pIcon = pSpecificInfo->getIcon() )
 291             {
 292                 // Without a command openoffice won't display the icon
 293                 if ( !sCommand.isEmpty() )
 294                 {
 295                     BitmapEx aBitEx( pIcon->getBitMap() );
 296                     TBCBitMap* pIconMask = pSpecificInfo->getIconMask();
 297                     if (pIconMask)
 298                     {
 299                         const Bitmap& rMaskBase(pIconMask->getBitMap().GetBitmap());
 300                         Size aMaskSize = rMaskBase.GetSizePixel();
 301                         if (aMaskSize.Width() && aMaskSize.Height())
 302                         {
 303                             // according to the spec:
 304                             // "the iconMask is white in all the areas in which the icon is
 305                             // displayed as transparent and is black in all other areas."
 306                             aBitEx = BitmapEx(aBitEx.GetBitmap(), rMaskBase.CreateMask(COL_WHITE));
 307                         }
 308                     }
 309
 310                     Graphic aGraphic( aBitEx );
 311                     helper.addIcon( aGraphic.GetXGraphic(), sCommand );
 312                 }
 313             }
 314             else if ( pSpecificInfo->getBtnFace() )
 315             {
 316
 317                 OUString sBuiltInCmd = helper.MSOTCIDToOOCommand(  *pSpecificInfo->getBtnFace() );
 318                 if ( !sBuiltInCmd.isEmpty() )
 319                 {
 320                     uno::Sequence<OUString> sCmds { sBuiltInCmd };
 321                     uno::Reference< ui::XImageManager > xImageManager( helper.getAppCfgManager()->getImageManager(), uno::UNO_QUERY_THROW );
 322                     // 0 = default image size
 323                     uno::Sequence< uno::Reference< graphic::XGraphic > > sImages = xImageManager->getImages( 0, sCmds );
 324                     if ( sImages.hasElements() && sImages[0].is() )
 325                         helper.addIcon( sImages[0], sCommand );
 326                 }
 327             }
 328         }
 329     }
 330     else if ( rHeader.getTct() == 0x0a )
 331     {
 332         aProp.Name = "CommandURL";
 333
 334         TBCMenuSpecific* pMenu = getMenuSpecific();
 335         if ( pMenu )
 336         {
 337             OUString sMenuBar = "private:resource/menubar/" + pMenu->Name();
 338             aProp.Value <<= sMenuBar; // name of popup
 339         }
 340         nStyle |= ui::ItemStyle::DROP_DOWN;
 341         props.push_back( aProp );
 342     }
 343
 344     short icontext =  ( rHeader.getTbct() & 0x03 );
 345     aProp.Name = "Style";
 346     if ( bIsMenuBar )
 347     {
 348         nStyle |= ui::ItemStyle::TEXT;
 349         if ( !icontext || icontext == 0x3 )
 350             // Text And image
 351             nStyle |= ui::ItemStyle::ICON;
 352     }
 353     else
 354     {
 355         if ( ( icontext & 0x02 ) == 0x02 )
 356             nStyle |= ui::ItemStyle::TEXT;
 357         if ( !icontext || ( icontext & 0x03 ) == 0x03 )
 358             nStyle |= ui::ItemStyle::ICON;
 359     }
 360     aProp.Value <<= nStyle;
 361     props.push_back( aProp );
 362 }
 363
 364 #ifdef DEBUG_FILTER_MSTOOLBAR
 365 void TBCData::Print( FILE* fp )
 366 {
 367     Indent a;
 368     indent_printf(fp,"[ 0x%x ] TBCData -- dump\n", nOffSet );
 369     indent_printf(fp,"  dumping controlGeneralInfo( TBCGeneralInfo )\n");
 370     controlGeneralInfo.Print( fp );
 371     //if ( rHeader.getTct() == 1 )
 372     if ( controlSpecificInfo.get() )
 373     {
 374         indent_printf(fp,"  dumping controlSpecificInfo( TBCBSpecificInfo )\n");
 375         controlSpecificInfo->Print( fp );
 376     }
 377 }
 378 #endif
 379
 380 bool
 381 WString::Read( SvStream &rS )
 382 {
 383     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 384     nOffSet = rS.Tell();
 385     sal_uInt8 nChars = 0;
 386     rS.ReadUChar( nChars );
 387     sString = read_uInt16s_ToOUString(rS, nChars);
 388     return true;
 389 }
 390
 391 TBCExtraInfo::TBCExtraInfo()
 392     : idHelpContext(0)
 393     , tbcu(0)
 394     , tbmg(0)
 395 {
 396 }
 397
 398 bool
 399 TBCExtraInfo::Read( SvStream &rS )
 400 {
 401     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 402     nOffSet = rS.Tell();
 403     if( !wstrHelpFile.Read( rS )  )
 404         return false;
 405
 406     rS.ReadInt32( idHelpContext );
 407
 408     if ( !wstrTag.Read( rS ) || !wstrOnAction.Read( rS ) || !wstrParam.Read( rS ) )
 409         return false;
 410
 411     rS.ReadSChar( tbcu ).ReadSChar( tbmg );
 412     return true;
 413 }
 414
 415 #ifdef DEBUG_FILTER_MSTOOLBAR
 416 void
 417 TBCExtraInfo::Print( FILE* fp )
 418 {
 419     Indent a;
 420     indent_printf( fp, "[ 0x%x ] TBCExtraInfo -- dump\n", nOffSet );
 421     indent_printf( fp, "  wstrHelpFile %s\n",
 422         OUStringToOString( wstrHelpFile.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 423     indent_printf( fp, "  idHelpContext 0x%x\n", static_cast< unsigned int >( idHelpContext ) );
 424     indent_printf( fp, "  wstrTag %s\n",
 425         OUStringToOString( wstrTag.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 426     indent_printf( fp, "  wstrOnAction %s\n",
 427         OUStringToOString( wstrOnAction.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 428     indent_printf( fp, "  wstrParam %s\n",
 429         OUStringToOString( wstrParam.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 430     indent_printf( fp, "  tbcu 0x%x\n", tbcu );
 431     indent_printf( fp, "  tbmg 0x%x\n", tbmg );
 432 }
 433 #endif
 434
 435 OUString const &
 436 TBCExtraInfo::getOnAction() const
 437 {
 438     return wstrOnAction.getString();
 439 }
 440
 441 TBCGeneralInfo::TBCGeneralInfo() : bFlags( 0 )
 442 {
 443 }
 444
 445 bool TBCGeneralInfo::Read( SvStream &rS )
 446 {
 447     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 448     nOffSet = rS.Tell();
 449     rS.ReadUChar( bFlags );
 450
 451     if ( ( bFlags & 0x1 ) && !customText.Read( rS ) )
 452         return false;
 453     if ( ( bFlags & 0x2 ) && ( !descriptionText.Read( rS ) ||  !tooltip.Read( rS ) ) )
 454         return false;
 455     if ( ( bFlags & 0x4 ) && !extraInfo.Read( rS ) )
 456         return false;
 457     return true;
 458 }
 459
 460 #ifdef DEBUG_FILTER_MSFILTER
 461 void
 462 TBCGeneralInfo::Print( FILE* fp )
 463 {
 464     Indent a;
 465     indent_printf( fp, "[ 0x%x ] TBCGeneralInfo -- dump\n", nOffSet );
 466     indent_printf( fp, "  bFlags 0x%x\n", bFlags );
 467     indent_printf( fp, "  customText %s\n",
 468         OUStringToOString( customText.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 469     indent_printf( fp, "  description %s\n",
 470         OUStringToOString( descriptionText.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 471     indent_printf( fp, "  tooltip %s\n",
 472         OUStringToOString( tooltip.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 473     if ( bFlags & 0x4 )
 474         extraInfo.Print( fp );
 475 }
 476 #endif
 477
 478 void
 479 TBCGeneralInfo::ImportToolBarControlData( CustomToolBarImportHelper& helper, std::vector< beans::PropertyValue >& sControlData )
 480 {
 481     if ( !(bFlags & 0x5) )
 482         return;
 483
 484     beans::PropertyValue aProp;
 485     // probably access to the header would be a better test than seeing if there is an action, e.g.
 486     // if ( rHeader.getTct() == 0x01 && rHeader.getTcID() == 0x01 ) // not defined, probably this is a command
 487     if ( !extraInfo.getOnAction().isEmpty() )
 488     {
 489         aProp.Name = "CommandURL";
 490         ooo::vba::MacroResolvedInfo aMacroInf = ooo::vba::resolveVBAMacro( &helper.GetDocShell(), extraInfo.getOnAction(), true );
 491         if ( aMacroInf.mbFound )
 492             aProp.Value = CustomToolBarImportHelper::createCommandFromMacro( aMacroInf.msResolvedMacro );
 493         else
 494             aProp.Value <<= "UnResolvedMacro[" + extraInfo.getOnAction() + "]";
 495         sControlData.push_back( aProp );
 496     }
 497
 498     aProp.Name = "Label";
 499     aProp.Value <<= customText.getString().replace('&','~');
 500     sControlData.push_back( aProp );
 501
 502     aProp.Name = "Type";
 503     aProp.Value <<= ui::ItemType::DEFAULT;
 504     sControlData.push_back( aProp );
 505
 506     aProp.Name = "Tooltip";
 507     aProp.Value <<= tooltip.getString();
 508     sControlData.push_back( aProp );
 509 /*
 510 aToolbarItem(0).Name = "CommandURL" wstrOnAction
 511 aToolbarItem(0).Value = Command
 512 aToolbarItem(1).Name = "Label"      customText
 513 aToolbarItem(1).Value = Label
 514 aToolbarItem(2).Name = "Type"
 515 aToolbarItem(2).Value = 0
 516 aToolbarItem(3).Name = "Visible"
 517 aToolbarItem(3).Value = true
 518 */
 519 }
 520
 521 TBCMenuSpecific::TBCMenuSpecific() : tbid( 0 )
 522 {
 523 }
 524
 525 bool
 526 TBCMenuSpecific::Read( SvStream &rS)
 527 {
 528     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 529     nOffSet = rS.Tell();
 530     rS.ReadInt32( tbid );
 531     if ( tbid == 1 )
 532     {
 533         name = std::make_shared<WString>();
 534         return name->Read( rS );
 535     }
 536     return true;
 537 }
 538
 539 #ifdef DEBUG_FILTER_MSFILTER
 540 void
 541 TBCMenuSpecific::Print( FILE* fp )
 542 {
 543     Indent a;
 544     indent_printf( fp, "[ 0x%x ] TBCMenuSpecific -- dump\n", nOffSet );
 545     indent_printf( fp, "  tbid 0x%x\n", static_cast< unsigned int >( tbid ) );
 546     if ( tbid == 1 )
 547         indent_printf( fp, "  name %s\n", OUStringToOString( name->getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 548 }
 549 #endif
 550
 551 OUString TBCMenuSpecific::Name()
 552 {
 553     OUString aName;
 554     if ( name )
 555         aName = name->getString();
 556     return aName;
 557 }
 558 TBCBSpecific::TBCBSpecific() : bFlags( 0 )
 559 {
 560 }
 561
 562 bool TBCBSpecific::Read( SvStream &rS)
 563 {
 564     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 565     nOffSet = rS.Tell();
 566     rS.ReadUChar( bFlags );
 567
 568     // bFlags determines what we read next
 569
 570     // bFlags.fCustomBitmap = 1 ( 0x8 ) set
 571     if ( bFlags & 0x8 )
 572     {
 573         icon = std::make_shared<TBCBitMap>();
 574         iconMask = std::make_shared<TBCBitMap>();
 575         if ( !icon->Read( rS ) || !iconMask->Read( rS ) )
 576             return false;
 577     }
 578     // if bFlags.fCustomBtnFace = 1 ( 0x10 )
 579     if ( bFlags & 0x10 )
 580     {
 581         iBtnFace = std::make_shared<sal_uInt16>();
 582         rS.ReadUInt16( *iBtnFace );
 583     }
 584     // if bFlags.fAccelerator equals 1 ( 0x04 )
 585     if ( bFlags & 0x04 )
 586     {
 587         wstrAcc = std::make_shared<WString>();
 588         return wstrAcc->Read( rS );
 589     }
 590     return true;
 591 }
 592
 593
 594 #ifdef DEBUG_FILTER_MSFILTER
 595 void TBCBSpecific::Print( FILE* fp )
 596 {
 597     Indent a;
 598     indent_printf( fp, "[ 0x%x ] TBCBSpecific -- dump\n", nOffSet );
 599     indent_printf( fp, "  bFlags 0x%x\n", bFlags );
 600     bool bResult = ( icon.get() != NULL );
 601     indent_printf( fp, "  icon present? %s\n", bResult ? "true" : "false" );
 602     if ( bResult )
 603     {
 604         Indent b;
 605         indent_printf( fp, "  icon: \n");
 606         icon->Print( fp ); // will dump size
 607     }
 608     bResult = ( iconMask.get() != NULL );
 609     indent_printf( fp, "  icon mask present? %s\n", bResult ? "true" : "false" );
 610     if ( bResult )
 611     {
 612         Indent c;
 613         indent_printf( fp, "  icon mask: \n");
 614         iconMask->Print( fp ); // will dump size
 615     }
 616     if ( iBtnFace.get() )
 617     {
 618         indent_printf( fp, "  iBtnFace 0x%x\n", *iBtnFace );
 619     }
 620     bResult = ( wstrAcc.get() != NULL );
 621     indent_printf( fp, "  option string present? %s ->%s<-\n", bResult ? "true" : "false", bResult ? OUStringToOString( wstrAcc->getString(), RTL_TEXTENCODING_UTF8 ).getStr() : "N/A" );
 622 }
 623 #endif
 624
 625 TBCBitMap*
 626 TBCBSpecific::getIcon()
 627 {
 628     return icon.get();
 629 }
 630
 631 TBCBitMap*
 632 TBCBSpecific::getIconMask()
 633 {
 634     return iconMask.get();
 635 }
 636
 637 TBCComboDropdownSpecific::TBCComboDropdownSpecific(const TBCHeader& header )
 638 {
 639     if ( header.getTcID() == 0x01 )
 640         data = std::make_shared<TBCCDData>();
 641 }
 642
 643 bool TBCComboDropdownSpecific::Read( SvStream &rS)
 644 {
 645     nOffSet = rS.Tell();
 646     if ( data )
 647         return data->Read( rS );
 648     return true;
 649 }
 650
 651 #ifdef DEBUG_FILTER_MSFILTER
 652 void TBCComboDropdownSpecific::Print( FILE* fp)
 653 {
 654     Indent a;
 655     indent_printf(fp,"[ 0x%x ] TBCComboDropdownSpecific -- dump\n", nOffSet );
 656     if ( data.get() )
 657         data->Print( fp );
 658     else
 659         indent_printf(fp," no data " );
 660 }
 661 #endif
 662
 663 TBCCDData::TBCCDData()
 664     : cwstrItems(0)
 665     , cwstrMRU(0)
 666     , iSel(0)
 667     , cLines(0)
 668     , dxWidth(0)
 669 {
 670 }
 671
 672 TBCCDData::~TBCCDData()
 673 {
 674 }
 675
 676 bool TBCCDData::Read( SvStream &rS)
 677 {
 678     nOffSet = rS.Tell();
 679     rS.ReadInt16( cwstrItems );
 680     if (cwstrItems > 0)
 681     {
 682         auto nItems = o3tl::make_unsigned(cwstrItems);
 683         //each WString is at least one byte
 684         if (rS.remainingSize() < nItems)
 685             return false;
 686         for (decltype(nItems) index = 0; index < nItems; ++index)
 687         {
 688             WString aString;
 689             if ( !aString.Read( rS ) )
 690                 return false;
 691             wstrList.push_back( aString );
 692         }
 693     }
 694     rS.ReadInt16( cwstrMRU ).ReadInt16( iSel ).ReadInt16( cLines ).ReadInt16( dxWidth );
 695
 696     return wstrEdit.Read( rS );
 697 }
 698
 699 #ifdef DEBUG_FILTER_MSFILTER
 700 void TBCCDData::Print( FILE* fp)
 701 {
 702     Indent a;
 703     indent_printf(fp,"[ 0x%x ] TBCCDData -- dump\n", nOffSet );
 704     indent_printf(fp,"  cwstrItems items in wstrList %d\n", cwstrItems);
 705     for ( sal_Int32 index=0; index < cwstrItems; ++index )
 706     {
 707         Indent b;
 708         indent_printf(fp, "  wstrList[%d] %s", static_cast< int >( index ), OUStringToOString( wstrList[index].getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 709     }
 710     indent_printf(fp,"  cwstrMRU num most recently used string %d item\n", cwstrMRU);
 711     indent_printf(fp,"  iSel index of selected item %d item\n", iSel);
 712     indent_printf(fp,"  cLines num of suggested lines to display %d", cLines);
 713     indent_printf(fp,"  dxWidth width in pixels %d", dxWidth);
 714     indent_printf(fp,"  wstrEdit %s", OUStringToOString( wstrEdit.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 715 }
 716 #endif
 717
 718 TBCBitMap::TBCBitMap() : cbDIB( 0 )
 719 {
 720 }
 721
 722 TBCBitMap::~TBCBitMap()
 723 {
 724 }
 725
 726 bool TBCBitMap::Read( SvStream& rS)
 727 {
 728     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 729     nOffSet = rS.Tell();
 730     rS.ReadInt32( cbDIB );
 731     // cbDIB = sizeOf(biHeader) + sizeOf(colors) + sizeOf(bitmapData) + 10
 732     return ReadDIBBitmapEx(mBitMap, rS, false, true);
 733 }
 734
 735 #ifdef DEBUG_FILTER_MSTOOLBAR
 736 void TBCBitMap::Print( FILE* fp )
 737 {
 738     Indent a;
 739     indent_printf(fp, "[ 0x%x ] TBCBitMap -- dump\n", nOffSet );
 740     indent_printf(fp, "  TBCBitMap size of bitmap data 0x%x\n", static_cast< unsigned int > ( cbDIB ) );
 741 }
 742 #endif
 743
 744 TB::TB() : bSignature(0x2),
 745 bVersion(0x1),
 746 cCL(0),
 747 ltbid( 0x1 ),
 748 ltbtr(0),
 749 cRowsDefault( 0 ),
 750 bFlags( 0 )
 751 {
 752 }
 753
 754 bool TB::Read(SvStream &rS)
 755 {
 756     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 757     nOffSet = rS.Tell();
 758     rS.ReadUChar( bSignature ).ReadUChar( bVersion ).ReadInt16( cCL ).ReadInt32( ltbid ).ReadUInt32( ltbtr ).ReadUInt16( cRowsDefault ).ReadUInt16( bFlags );
 759     name.Read( rS );
 760     return true;
 761
 762 }
 763
 764 bool TB::IsEnabled() const
 765 {
 766     return ( bFlags & 0x01 ) != 0x01;
 767 }
 768
 769 #ifdef DEBUG_FILTER_MSTOOLBAR
 770 void TB::Print( FILE* fp )
 771 {
 772     Indent a;
 773     indent_printf(fp,"[ 0x%x ] TB -- dump\n", nOffSet );
 774     indent_printf(fp,"  bSignature 0x%x\n", bSignature );
 775     indent_printf(fp,"  bVersion 0x%x\n", bVersion );
 776     indent_printf(fp,"  cCL 0x%x\n", cCL );
 777     indent_printf(fp,"  ltbid 0x%x\n", ltbid );
 778     indent_printf(fp,"  ltbtr 0x%x\n", ltbtr );
 779     indent_printf(fp,"  cRowsDefault 0x%x\n", cRowsDefault );
 780     indent_printf(fp,"  bFlags 0x%x\n", bFlags );
 781     indent_printf(fp, "  name %s\n", OUStringToOString( name.getString(), RTL_TEXTENCODING_UTF8 ).getStr() );
 782 }
 783 #endif
 784
 785 TBVisualData::TBVisualData() : tbds(0), tbv(0), tbdsDock(0), iRow(0)
 786 {
 787 }
 788
 789 bool TBVisualData::Read( SvStream& rS )
 790 {
 791     SAL_INFO("filter.ms", "stream pos " << rS.Tell());
 792     nOffSet = rS.Tell();
 793     rS.ReadSChar( tbds ).ReadSChar( tbv ).ReadSChar( tbdsDock ).ReadSChar( iRow );
 794     rcDock.Read( rS );
 795     rcFloat.Read( rS );
 796     return true;
 797 }
 798
 799 #ifdef DEBUG_FILTER_MSTOOLBAR
 800 void SRECT::Print( FILE* fp )
 801 {
 802     Indent a;
 803     indent_printf( fp, "  left 0x%x\n", left);
 804     indent_printf( fp, "  top 0x%x\n", top);
 805     indent_printf( fp, "  right 0x%x\n", right);
 806     indent_printf( fp, "  bottom 0x%x\n", bottom);
 807 }
 808 #endif
 809
 810 #ifdef DEBUG_FILTER_MSTOOLBAR
 811 void TBVisualData::Print( FILE* fp )
 812 {
 813     Indent a;
 814     indent_printf( fp, "[ 0x%x ] TBVisualData -- dump\n", nOffSet );
 815     indent_printf( fp, "  tbds 0x%x\n", tbds);
 816     indent_printf( fp, "  tbv  0x%x\n", tbv);
 817     indent_printf( fp, "  tbdsDoc  0x%x\n", tbdsDock);
 818     indent_printf( fp, "  iRow  0x%x\n", iRow);
 819     rcDock.Print( fp );
 820     rcFloat.Print( fp );
 821 }
 822 #endif
 823
 824 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */