framework/source/xml/imagesdocumenthandler.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: imagesdocumenthandler.cxx,v $
  10  * $Revision: 1.11 $
  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_framework.hxx"
  33
  34 #include <stdio.h>
  35
  36 //_________________________________________________________________________________________________________________
  37 //      my own includes
  38 //_________________________________________________________________________________________________________________
  39
  40 #include <threadhelp/resetableguard.hxx>
  41 #include <xml/imagesdocumenthandler.hxx>
  42 #include <macros/debug.hxx>
  43
  44 //_________________________________________________________________________________________________________________
  45 //      interface includes
  46 //_________________________________________________________________________________________________________________
  47
  48 #ifndef __COM_SUN_STAR_XML_SAX_XEXTENDEDDOCUMENTHANDLER_HPP_
  49 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  50 #endif
  51
  52 //_________________________________________________________________________________________________________________
  53 //      other includes
  54 //_________________________________________________________________________________________________________________
  55 #include <vcl/svapp.hxx>
  56 #include <vcl/toolbox.hxx>
  57 #include <rtl/ustrbuf.hxx>
  58
  59 #include <comphelper/attributelist.hxx>
  60
  61 //_________________________________________________________________________________________________________________
  62 //      namespace
  63 //_________________________________________________________________________________________________________________
  64
  65 using namespace ::com::sun::star::uno;
  66 using namespace ::com::sun::star::xml::sax;
  67
  68 #define ELEMENT_IMAGECONTAINER          "imagescontainer"
  69 #define ELEMENT_IMAGES                          "images"
  70 #define ELEMENT_ENTRY                           "entry"
  71 #define ELEMENT_EXTERNALIMAGES          "externalimages"
  72 #define ELEMENT_EXTERNALENTRY           "externalentry"
  73
  74 #define ELEMENT_NS_IMAGESCONTAINER      "image:imagescontainer"
  75 #define ELEMENT_NS_IMAGES                       "image:images"
  76 #define ELEMENT_NS_ENTRY                        "image:entry"
  77 #define ELEMENT_NS_EXTERNALIMAGES       "image:externalimages"
  78 #define ELEMENT_NS_EXTERNALENTRY        "image:externalentry"
  79
  80 #define ATTRIBUTE_HREF                                  "href"
  81 #define ATTRIBUTE_MASKCOLOR                             "maskcolor"
  82 #define ATTRIBUTE_COMMAND                               "command"
  83 #define ATTRIBUTE_BITMAPINDEX                   "bitmap-index"
  84 #define ATTRIBUTE_MASKURL                               "maskurl"
  85 #define ATTRIBUTE_MASKMODE                              "maskmode"
  86 #define ATTRIBUTE_HIGHCONTRASTURL               "highcontrasturl"
  87 #define ATTRIBUTE_HIGHCONTRASTMASKURL   "highcontrastmaskurl"
  88 #define ATTRIBUTE_TYPE_CDATA                    "CDATA"
  89
  90 #define ATTRIBUTE_MASKMODE_BITMAP       "maskbitmap"
  91 #define ATTRIBUTE_MASKMODE_COLOR        "maskcolor"
  92
  93 #define ATTRIBUTE_XMLNS_IMAGE           "xmlns:image"
  94 #define ATTRIBUTE_XMLNS_XLINK           "xmlns:xlink"
  95
  96 #define ATTRIBUTE_XLINK_TYPE            "xlink:type"
  97 #define ATTRIBUTE_XLINK_TYPE_VALUE      "simple"
  98
  99 #define XMLNS_IMAGE                                     "http://openoffice.org/2001/image"
 100 #define XMLNS_XLINK                                     "http://www.w3.org/1999/xlink"
 101 #define XMLNS_IMAGE_PREFIX                      "image:"
 102 #define XMLNS_XLINK_PREFIX                      "xlink:"
 103
 104 #define XMLNS_FILTER_SEPARATOR          "^"
 105
 106 #define IMAGES_DOCTYPE  "<!DOCTYPE image:imagecontainer PUBLIC \"-//OpenOffice.org//DTD OfficeDocument 1.0//EN\" \"image.dtd\">"
 107
 108 namespace framework
 109 {
 110
 111 struct ImageXMLEntryProperty
 112 {
 113     OReadImagesDocumentHandler::Image_XML_Namespace     nNamespace;
 114     char                                                                                        aEntryName[20];
 115 };
 116
 117 ImageXMLEntryProperty ImagesEntries[OReadImagesDocumentHandler::IMG_XML_ENTRY_COUNT] =
 118 {
 119     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ELEMENT_IMAGECONTAINER                  },
 120     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ELEMENT_IMAGES                                  },
 121     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ELEMENT_ENTRY                                   },
 122     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ELEMENT_EXTERNALIMAGES                  },
 123     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ELEMENT_EXTERNALENTRY                   },
 124     { OReadImagesDocumentHandler::IMG_NS_XLINK, ATTRIBUTE_HREF                                  },
 125     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_MASKCOLOR                             },
 126     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_COMMAND                               },
 127     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_BITMAPINDEX                   },
 128     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_MASKURL                               },
 129     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_MASKMODE                              },
 130     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_HIGHCONTRASTURL               },
 131     { OReadImagesDocumentHandler::IMG_NS_IMAGE, ATTRIBUTE_HIGHCONTRASTMASKURL   }
 132 };
 133
 134
 135 OReadImagesDocumentHandler::OReadImagesDocumentHandler( ImageListsDescriptor& aItems ) :
 136     ThreadHelpBase( &Application::GetSolarMutex() ),
 137     m_aImageList( aItems ),
 138     m_pImages( 0 ),
 139     m_pExternalImages( 0 )
 140 {
 141     m_aImageList.pImageList                     = NULL;
 142     m_aImageList.pExternalImageList = NULL;
 143
 144     m_nHashMaskModeBitmap       = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE_BITMAP )).hashCode();
 145     m_nHashMaskModeColor        = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE_COLOR )).hashCode();
 146
 147     // create hash map to speed up lookup
 148     for ( int i = 0; i < (int)IMG_XML_ENTRY_COUNT; i++ )
 149     {
 150         ::rtl::OUStringBuffer temp( 20 );
 151
 152         if ( ImagesEntries[i].nNamespace == IMG_NS_IMAGE )
 153             temp.appendAscii( XMLNS_IMAGE );
 154         else
 155             temp.appendAscii( XMLNS_XLINK );
 156
 157         temp.appendAscii( XMLNS_FILTER_SEPARATOR );
 158         temp.appendAscii( ImagesEntries[i].aEntryName );
 159         m_aImageMap.insert( ImageHashMap::value_type( temp.makeStringAndClear(), (Image_XML_Entry)i ) );
 160     }
 161
 162     // reset states
 163     m_bImageContainerStartFound         = sal_False;
 164     m_bImageContainerEndFound           = sal_False;
 165     m_bImagesStartFound                         = sal_False;
 166     m_bImagesEndFound                           = sal_False;
 167     m_bImageStartFound                          = sal_False;
 168     m_bExternalImagesStartFound         = sal_False;
 169     m_bExternalImagesEndFound           = sal_False;
 170     m_bExternalImageStartFound          = sal_False;
 171 }
 172
 173 OReadImagesDocumentHandler::~OReadImagesDocumentHandler()
 174 {
 175 }
 176
 177 // XDocumentHandler
 178 void SAL_CALL OReadImagesDocumentHandler::startDocument(void)
 179 throw ( SAXException, RuntimeException )
 180 {
 181 }
 182
 183 void SAL_CALL OReadImagesDocumentHandler::endDocument(void)
 184 throw(  SAXException, RuntimeException )
 185 {
 186     ResetableGuard aGuard( m_aLock );
 187
 188     if (( m_bImageContainerStartFound && !m_bImageContainerEndFound ) ||
 189         ( !m_bImageContainerStartFound && m_bImageContainerEndFound )    )
 190     {
 191         ::rtl::OUString aErrorMessage = getErrorLineString();
 192         aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No matching start or end element 'image:imagecontainer' found!" ));
 193         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 194     }
 195 }
 196
 197 void SAL_CALL OReadImagesDocumentHandler::startElement(
 198     const ::rtl::OUString& aName, const Reference< XAttributeList > &xAttribs )
 199 throw(  SAXException, RuntimeException )
 200 {
 201     ResetableGuard aGuard( m_aLock );
 202
 203     ImageHashMap::const_iterator pImageEntry = m_aImageMap.find( aName ) ;
 204     if ( pImageEntry != m_aImageMap.end() )
 205     {
 206         switch ( pImageEntry->second )
 207         {
 208             case IMG_ELEMENT_IMAGECONTAINER:
 209             {
 210                 // image:imagecontainer element (container element for all further image elements)
 211                 if ( m_bImageContainerStartFound )
 212                 {
 213                     ::rtl::OUString aErrorMessage = getErrorLineString();
 214                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:imagecontainer' cannot be embeded into 'image:imagecontainer'!" ));
 215                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 216                 }
 217
 218                 m_bImageContainerStartFound = sal_True;
 219             }
 220             break;
 221
 222             case IMG_ELEMENT_IMAGES:
 223             {
 224                 if ( !m_bImageContainerStartFound )
 225                 {
 226                     ::rtl::OUString aErrorMessage = getErrorLineString();
 227                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:images' must be embeded into element 'image:imagecontainer'!" ));
 228                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 229                 }
 230
 231                 if ( m_bImagesStartFound )
 232                 {
 233                     ::rtl::OUString aErrorMessage = getErrorLineString();
 234                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:images' cannot be embeded into 'image:images'!" ));
 235                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 236                 }
 237
 238                 if ( !m_aImageList.pImageList )
 239                     m_aImageList.pImageList = new ImageListDescriptor;
 240
 241                 m_bImagesStartFound = sal_True;
 242                 m_pImages = new ImageListItemDescriptor;
 243
 244                 for ( sal_Int16 n = 0; n < xAttribs->getLength(); n++ )
 245                 {
 246                     pImageEntry = m_aImageMap.find( xAttribs->getNameByIndex( n ) );
 247                     if ( pImageEntry != m_aImageMap.end() )
 248                     {
 249                         switch ( pImageEntry->second )
 250                         {
 251                             case IMG_ATTRIBUTE_HREF:
 252                             {
 253                                 m_pImages->aURL = xAttribs->getValueByIndex( n );
 254                             }
 255                             break;
 256
 257                             case IMG_ATTRIBUTE_MASKCOLOR:
 258                             {
 259                                 ::rtl::OUString aColor = xAttribs->getValueByIndex( n );
 260
 261                                 if ( aColor.getLength() > 0 )
 262                                 {
 263                                     if ( aColor.getStr()[0] == '#' )
 264                                     {
 265                                         // the color value is given as #rrggbb and used the hexadecimal system!!
 266                                         sal_uInt32 nColor = aColor.copy( 1 ).toInt32( 16 );
 267
 268                                         m_pImages->aMaskColor = Color( COLORDATA_RGB( nColor ) );
 269                                     }
 270                                 }
 271                             }
 272                             break;
 273
 274                             case IMG_ATTRIBUTE_MASKURL:
 275                             {
 276                                 m_pImages->aMaskURL = xAttribs->getValueByIndex( n );
 277                             }
 278                             break;
 279
 280                             case IMG_ATTRIBUTE_MASKMODE:
 281                             {
 282                                 sal_Int32 nHashCode = xAttribs->getValueByIndex( n ).hashCode();
 283                                 if ( nHashCode == m_nHashMaskModeBitmap )
 284                                     m_pImages->nMaskMode = ImageMaskMode_Bitmap;
 285                                 else if ( nHashCode == m_nHashMaskModeColor )
 286                                     m_pImages->nMaskMode = ImageMaskMode_Color;
 287                                 else
 288                                 {
 289                                     delete m_pImages;
 290                                     m_pImages = NULL;
 291
 292                                     ::rtl::OUString aErrorMessage = getErrorLineString();
 293                                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Attribute image:maskmode must be 'maskcolor' or 'maskbitmap'!" ));
 294                                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 295                                 }
 296                             }
 297                             break;
 298
 299                             case IMG_ATTRIBUTE_HIGHCONTRASTURL:
 300                             {
 301                                 m_pImages->aHighContrastURL = xAttribs->getValueByIndex( n );
 302                             }
 303                             break;
 304
 305                             case IMG_ATTRIBUTE_HIGHCONTRASTMASKURL:
 306                             {
 307                                 m_pImages->aHighContrastMaskURL = xAttribs->getValueByIndex( n );
 308                             }
 309                             break;
 310
 311                                           default:
 312                                               break;
 313                         }
 314                     }
 315                 } // for
 316
 317                 if ( m_pImages->aURL.Len() == 0 )
 318                 {
 319                     delete m_pImages;
 320                     m_pImages = NULL;
 321
 322                     ::rtl::OUString aErrorMessage = getErrorLineString();
 323                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute xlink:href must have a value!" ));
 324                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 325                 }
 326             }
 327             break;
 328
 329             case IMG_ELEMENT_ENTRY:
 330             {
 331                 // Check that image:entry is embeded into image:images!
 332                 if ( !m_bImagesStartFound )
 333                 {
 334                     delete m_pImages;
 335                     m_pImages = NULL;
 336
 337                     ::rtl::OUString aErrorMessage = getErrorLineString();
 338                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:entry' must be embeded into element 'image:images'!" ));
 339                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 340                 }
 341
 342                 if ( !m_pImages->pImageItemList )
 343                     m_pImages->pImageItemList = new ImageItemListDescriptor;
 344
 345                 m_bImageStartFound = sal_True;
 346
 347                 // Create new image item descriptor
 348                 ImageItemDescriptor* pItem = new ImageItemDescriptor;
 349                 pItem->nIndex = -1;
 350
 351                 // Read attributes for this image definition
 352                 for ( sal_Int16 n = 0; n < xAttribs->getLength(); n++ )
 353                 {
 354                     pImageEntry = m_aImageMap.find( xAttribs->getNameByIndex( n ) );
 355                     if ( pImageEntry != m_aImageMap.end() )
 356                     {
 357                         switch ( pImageEntry->second )
 358                         {
 359                             case IMG_ATTRIBUTE_COMMAND:
 360                             {
 361                                 pItem->aCommandURL      = xAttribs->getValueByIndex( n );
 362                             }
 363                             break;
 364
 365                             case IMG_ATTRIBUTE_BITMAPINDEX:
 366                             {
 367                                 pItem->nIndex           = xAttribs->getValueByIndex( n ).toInt32();
 368                             }
 369                             break;
 370
 371                                           default:
 372                                               break;
 373                         }
 374                     }
 375                 }
 376
 377                 // Check required attribute "bitmap-index"
 378                 if ( pItem->nIndex < 0 )
 379                 {
 380                     delete pItem;
 381                     delete m_pImages;
 382                     m_pImages = NULL;
 383
 384                     ::rtl::OUString aErrorMessage = getErrorLineString();
 385                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute 'image:bitmap-index' must have a value >= 0!" ));
 386                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 387                 }
 388
 389                 // Check required attribute "command"
 390                 if ( pItem->aCommandURL.Len() == 0 )
 391                 {
 392                     delete pItem;
 393                     delete m_pImages;
 394                     m_pImages = NULL;
 395
 396                     ::rtl::OUString aErrorMessage = getErrorLineString();
 397                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute 'image:command' must have a value!" ));
 398                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 399                 }
 400
 401                 if ( m_pImages )
 402                     m_pImages->pImageItemList->Insert( pItem, m_pImages->pImageItemList->Count() );
 403             }
 404             break;
 405
 406             case IMG_ELEMENT_EXTERNALIMAGES:
 407             {
 408                 // Check that image:externalimages is embeded into image:imagecontainer
 409                 if ( !m_bImageContainerStartFound )
 410                 {
 411                     delete m_pImages;
 412                     m_pImages = NULL;
 413
 414                     ::rtl::OUString aErrorMessage = getErrorLineString();
 415                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:externalimages' must be embeded into element 'image:imagecontainer'!" ));
 416                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 417                 }
 418
 419                 // Check that image:externalentry is NOT embeded into image:externalentry
 420                 if ( m_bExternalImagesStartFound )
 421                 {
 422                     delete m_pImages;
 423                     m_pImages = NULL;
 424
 425                     ::rtl::OUString aErrorMessage = getErrorLineString();
 426                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:externalimages' cannot be embeded into 'image:externalimages'!" ));
 427                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 428                 }
 429
 430                 // Create unique external image container
 431                 m_bExternalImagesStartFound = sal_True;
 432                 m_pExternalImages = new ExternalImageItemListDescriptor;
 433             }
 434             break;
 435
 436             case IMG_ELEMENT_EXTERNALENTRY:
 437             {
 438                 if ( !m_bExternalImagesStartFound )
 439                 {
 440                     delete m_pImages;
 441                     delete m_pExternalImages;
 442                     m_pImages = NULL;
 443                     m_pExternalImages = NULL;
 444
 445                     ::rtl::OUString aErrorMessage = getErrorLineString();
 446                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:externalentry' must be embeded into 'image:externalimages'!" ));
 447                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 448                 }
 449
 450                 if ( m_bExternalImageStartFound )
 451                 {
 452                     delete m_pImages;
 453                     delete m_pExternalImages;
 454                     m_pImages = NULL;
 455                     m_pExternalImages = NULL;
 456
 457                     ::rtl::OUString aErrorMessage = getErrorLineString();
 458                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'image:externalentry' cannot be embeded into 'image:externalentry'!" ));
 459                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 460                 }
 461
 462                 m_bExternalImageStartFound = sal_True;
 463
 464                 ExternalImageItemDescriptor* pItem = new ExternalImageItemDescriptor;
 465
 466                 // Read attributes for this external image definition
 467                 for ( sal_Int16 n = 0; n < xAttribs->getLength(); n++ )
 468                 {
 469                     pImageEntry = m_aImageMap.find( xAttribs->getNameByIndex( n ) );
 470                     if ( pImageEntry != m_aImageMap.end() )
 471                     {
 472                         switch ( pImageEntry->second )
 473                         {
 474                             case IMG_ATTRIBUTE_COMMAND:
 475                             {
 476                                 pItem->aCommandURL      = xAttribs->getValueByIndex( n );
 477                             }
 478                             break;
 479
 480                             case IMG_ATTRIBUTE_HREF:
 481                             {
 482                                 pItem->aURL                     = xAttribs->getValueByIndex( n );
 483                             }
 484                             break;
 485
 486                                           default:
 487                                               break;
 488                         }
 489                     }
 490                 }
 491
 492                 // Check required attribute "command"
 493                 if ( pItem->aCommandURL.Len() == 0 )
 494                 {
 495                     delete pItem;
 496                     delete m_pImages;
 497                     delete m_pExternalImages;
 498                     m_pImages = NULL;
 499                     m_pExternalImages = NULL;
 500
 501                     ::rtl::OUString aErrorMessage = getErrorLineString();
 502                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute 'image:command' must have a value!" ));
 503                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 504                 }
 505
 506                 // Check required attribute "href"
 507                 if ( pItem->aURL.Len() == 0 )
 508                 {
 509                     delete pItem;
 510                     delete m_pImages;
 511                     delete m_pExternalImages;
 512                     m_pImages = NULL;
 513                     m_pExternalImages = NULL;
 514
 515                     ::rtl::OUString aErrorMessage = getErrorLineString();
 516                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute 'xlink:href' must have a value!" ));
 517                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 518                 }
 519
 520                 if ( m_pExternalImages )
 521                     m_pExternalImages->Insert( pItem, m_pExternalImages->Count() );
 522             }
 523             break;
 524
 525                   default:
 526                       break;
 527         }
 528     }
 529 }
 530
 531 void SAL_CALL OReadImagesDocumentHandler::endElement(const ::rtl::OUString& aName)
 532 throw(  SAXException, RuntimeException )
 533 {
 534     ResetableGuard aGuard( m_aLock );
 535
 536     ImageHashMap::const_iterator pImageEntry = m_aImageMap.find( aName ) ;
 537     if ( pImageEntry != m_aImageMap.end() )
 538     {
 539         switch ( pImageEntry->second )
 540         {
 541             case IMG_ELEMENT_IMAGECONTAINER:
 542             {
 543                 m_bImageContainerEndFound = sal_True;
 544             }
 545             break;
 546
 547             case IMG_ELEMENT_IMAGES:
 548             {
 549                 if ( m_pImages )
 550                 {
 551                     if ( m_aImageList.pImageList )
 552                         m_aImageList.pImageList->Insert( m_pImages, m_aImageList.pImageList->Count() );
 553                     m_pImages = NULL;
 554                 }
 555                 m_bImagesStartFound = sal_False;
 556             }
 557             break;
 558
 559             case IMG_ELEMENT_ENTRY:
 560             {
 561                 m_bImageStartFound = sal_False;
 562             }
 563             break;
 564
 565             case IMG_ELEMENT_EXTERNALIMAGES:
 566             {
 567                 if ( m_pExternalImages && !m_aImageList.pExternalImageList )
 568                 {
 569                     if ( !m_aImageList.pExternalImageList )
 570                         m_aImageList.pExternalImageList = m_pExternalImages;
 571                 }
 572
 573                 m_bExternalImagesStartFound = sal_False;
 574                 m_pExternalImages = NULL;
 575             }
 576             break;
 577
 578             case IMG_ELEMENT_EXTERNALENTRY:
 579             {
 580                 m_bExternalImageStartFound = sal_False;
 581             }
 582             break;
 583
 584                   default:
 585                       break;
 586         }
 587     }
 588 }
 589
 590 void SAL_CALL OReadImagesDocumentHandler::characters(const ::rtl::OUString&)
 591 throw(  SAXException, RuntimeException )
 592 {
 593 }
 594
 595 void SAL_CALL OReadImagesDocumentHandler::ignorableWhitespace(const ::rtl::OUString&)
 596 throw(  SAXException, RuntimeException )
 597 {
 598 }
 599
 600 void SAL_CALL OReadImagesDocumentHandler::processingInstruction(
 601     const ::rtl::OUString& /*aTarget*/, const ::rtl::OUString& /*aData*/ )
 602 throw(  SAXException, RuntimeException )
 603 {
 604 }
 605
 606 void SAL_CALL OReadImagesDocumentHandler::setDocumentLocator(
 607     const Reference< XLocator > &xLocator)
 608 throw(  SAXException, RuntimeException )
 609 {
 610     ResetableGuard aGuard( m_aLock );
 611
 612     m_xLocator = xLocator;
 613 }
 614
 615 ::rtl::OUString OReadImagesDocumentHandler::getErrorLineString()
 616 {
 617     ResetableGuard aGuard( m_aLock );
 618
 619     char buffer[32];
 620
 621     if ( m_xLocator.is() )
 622     {
 623         snprintf( buffer, sizeof(buffer), "Line: %ld - ", static_cast<long>( m_xLocator->getLineNumber() ));
 624         return ::rtl::OUString::createFromAscii( buffer );
 625     }
 626     else
 627         return ::rtl::OUString();
 628 }
 629
 630
 631 //_________________________________________________________________________________________________________________
 632 //      OWriteImagesDocumentHandler
 633 //_________________________________________________________________________________________________________________
 634
 635 OWriteImagesDocumentHandler::OWriteImagesDocumentHandler(
 636     const ImageListsDescriptor& aItems,
 637     Reference< XDocumentHandler > rWriteDocumentHandler ) :
 638     ThreadHelpBase( &Application::GetSolarMutex() ),
 639     m_aImageListsItems( aItems ),
 640     m_xWriteDocumentHandler( rWriteDocumentHandler )
 641 {
 642     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 643     m_xEmptyList                        = Reference< XAttributeList >( (XAttributeList *) pList, UNO_QUERY );
 644     m_aAttributeType            = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_TYPE_CDATA ));
 645     m_aXMLImageNS                       = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_IMAGE_PREFIX ));
 646     m_aXMLXlinkNS                       = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_XLINK_PREFIX ));
 647     m_aAttributeXlinkType       = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XLINK_TYPE ));
 648     m_aAttributeValueSimple = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XLINK_TYPE_VALUE ));
 649 }
 650
 651 OWriteImagesDocumentHandler::~OWriteImagesDocumentHandler()
 652 {
 653 }
 654
 655 void OWriteImagesDocumentHandler::WriteImagesDocument() throw
 656 ( SAXException, RuntimeException )
 657 {
 658     ResetableGuard aGuard( m_aLock );
 659
 660     m_xWriteDocumentHandler->startDocument();
 661
 662     // write DOCTYPE line!
 663     Reference< XExtendedDocumentHandler > xExtendedDocHandler( m_xWriteDocumentHandler, UNO_QUERY );
 664     if ( xExtendedDocHandler.is() )
 665     {
 666         xExtendedDocHandler->unknown( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( IMAGES_DOCTYPE )) );
 667         m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 668     }
 669
 670     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 671     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 672
 673     pList->AddAttribute( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XMLNS_IMAGE )),
 674                          m_aAttributeType,
 675                          ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_IMAGE )) );
 676
 677     pList->AddAttribute( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XMLNS_XLINK )),
 678                          m_aAttributeType,
 679                          ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_XLINK )) );
 680
 681     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_IMAGESCONTAINER )), pList );
 682     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 683
 684     if ( m_aImageListsItems.pImageList )
 685     {
 686         ImageListDescriptor* pImageList = m_aImageListsItems.pImageList;
 687
 688         for ( USHORT i = 0; i < m_aImageListsItems.pImageList->Count(); i++ )
 689         {
 690             const ImageListItemDescriptor* pImageItems = (*pImageList)[i];
 691             WriteImageList( pImageItems );
 692         }
 693     }
 694
 695     if ( m_aImageListsItems.pExternalImageList )
 696     {
 697         WriteExternalImageList( m_aImageListsItems.pExternalImageList );
 698     }
 699
 700     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 701     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_IMAGESCONTAINER )) );
 702     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 703     m_xWriteDocumentHandler->endDocument();
 704 }
 705
 706 //_________________________________________________________________________________________________________________
 707 //      protected member functions
 708 //_________________________________________________________________________________________________________________
 709
 710 void OWriteImagesDocumentHandler::WriteImageList( const ImageListItemDescriptor* pImageList ) throw
 711 ( SAXException, RuntimeException )
 712 {
 713     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 714     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 715
 716     // save required attributes
 717     pList->AddAttribute( m_aAttributeXlinkType,
 718                          m_aAttributeType,
 719                          m_aAttributeValueSimple );
 720
 721     pList->AddAttribute( m_aXMLXlinkNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_HREF )),
 722                          m_aAttributeType,
 723                          pImageList->aURL );
 724
 725     if ( pImageList->nMaskMode == ImageMaskMode_Bitmap )
 726     {
 727         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE )),
 728                              m_aAttributeType,
 729                              ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE_BITMAP )) );
 730
 731         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKURL )),
 732                              m_aAttributeType,
 733                              pImageList->aMaskURL );
 734
 735         if ( pImageList->aHighContrastMaskURL.Len() > 0 )
 736         {
 737             pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_HIGHCONTRASTMASKURL )),
 738                                  m_aAttributeType,
 739                                  pImageList->aHighContrastMaskURL );
 740         }
 741     }
 742     else
 743     {
 744         ::rtl::OUStringBuffer   aColorStrBuffer( 8 );
 745         sal_Int64               nValue = pImageList->aMaskColor.GetRGBColor();
 746
 747         aColorStrBuffer.appendAscii( "#" );
 748         aColorStrBuffer.append( ::rtl::OUString::valueOf( nValue, 16 ));
 749
 750         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKCOLOR )),
 751                              m_aAttributeType,
 752                              aColorStrBuffer.makeStringAndClear() );
 753
 754         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE )),
 755                              m_aAttributeType,
 756                              ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_MASKMODE_COLOR )) );
 757     }
 758
 759     if ( pImageList->aHighContrastURL.Len() > 0 )
 760     {
 761         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_HIGHCONTRASTURL )),
 762                              m_aAttributeType,
 763                              pImageList->aHighContrastURL );
 764     }
 765
 766     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_IMAGES )), xList );
 767     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 768
 769     ImageItemListDescriptor* pImageItemList = pImageList->pImageItemList;
 770     if ( pImageItemList )
 771     {
 772         for ( USHORT i = 0; i < pImageItemList->Count(); i++ )
 773             WriteImage( (*pImageItemList)[i] );
 774     }
 775
 776     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_IMAGES )) );
 777     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 778 }
 779
 780 void OWriteImagesDocumentHandler::WriteImage( const ImageItemDescriptor* pImage ) throw
 781 ( SAXException, RuntimeException )
 782 {
 783     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 784     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 785
 786     pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_BITMAPINDEX )),
 787                          m_aAttributeType,
 788                          ::rtl::OUString::valueOf( (sal_Int32)pImage->nIndex ) );
 789
 790     pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_COMMAND )),
 791                          m_aAttributeType,
 792                          pImage->aCommandURL );
 793
 794     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_ENTRY )), xList );
 795     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 796
 797     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_ENTRY )) );
 798     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 799 }
 800
 801 void OWriteImagesDocumentHandler::WriteExternalImageList( const ExternalImageItemListDescriptor* pExternalImageList ) throw
 802 ( SAXException, RuntimeException )
 803 {
 804     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_EXTERNALIMAGES )), m_xEmptyList );
 805     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 806
 807     for ( USHORT i = 0; i < pExternalImageList->Count(); i++ )
 808     {
 809         ExternalImageItemDescriptor* pItem = (*pExternalImageList)[i];
 810         WriteExternalImage( pItem );
 811     }
 812
 813     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 814     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_EXTERNALIMAGES )) );
 815     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 816 }
 817
 818 void OWriteImagesDocumentHandler::WriteExternalImage( const ExternalImageItemDescriptor* pExternalImage ) throw
 819 ( SAXException, RuntimeException )
 820 {
 821     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 822     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 823
 824     // save required attributes
 825     pList->AddAttribute( m_aAttributeXlinkType,
 826                          m_aAttributeType,
 827                          m_aAttributeValueSimple );
 828
 829     if ( pExternalImage->aURL.Len() > 0 )
 830     {
 831         pList->AddAttribute( m_aXMLXlinkNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_HREF )),
 832                              m_aAttributeType,
 833                              pExternalImage->aURL );
 834     }
 835
 836     if ( pExternalImage->aCommandURL.Len() > 0 )
 837     {
 838         pList->AddAttribute( m_aXMLImageNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_COMMAND )),
 839                              m_aAttributeType,
 840                              pExternalImage->aCommandURL );
 841     }
 842
 843     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_EXTERNALENTRY )), xList );
 844     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 845
 846     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_EXTERNALENTRY )) );
 847     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 848 }
 849
 850 } // namespace framework
 851
 852
 853
 854