svtools/bmpmaker/bmpcore.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: bmpcore.cxx,v $
  10  * $Revision: 1.19 $
  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_svtools.hxx"
  33
  34 #include <tools/color.hxx>
  35 #include <vcl/bmpacc.hxx>
  36 #include <vcl/bitmapex.hxx>
  37 #include <vcl/alpha.hxx>
  38 #include <vcl/pngread.hxx>
  39 #include <vcl/pngwrite.hxx>
  40 #include "bmpcore.hxx"
  41
  42 #include <vector>
  43 #include <algorithm>
  44
  45 #undef WRITE_ALPHA_PNG
  46
  47 // -------------------------
  48 // - ImplGetSystemFileName -
  49 // -------------------------
  50
  51 static String ImplGetSystemFileName( const String& rFileName )
  52 {
  53     String              aRet( rFileName );
  54     const sal_Unicode   aReplace = DirEntry::GetAccessDelimiter( FSYS_STYLE_HOST ).GetChar( 0 );
  55
  56     aRet.SearchAndReplaceAll( '/', aReplace );
  57     aRet.SearchAndReplaceAll( '\\', aReplace );
  58
  59     return aRet;
  60 }
  61
  62 // --------------
  63 // - BmpCreator -
  64 // --------------
  65
  66 BmpCreator::BmpCreator()
  67 {
  68 }
  69
  70 // -----------------------------------------------------------------------------
  71
  72 BmpCreator::~BmpCreator()
  73 {
  74 }
  75
  76 // -----------------------------------------------------------------------------
  77
  78 void BmpCreator::Message( const String&, BYTE )
  79 {
  80 }
  81
  82 // -----------------------------------------------------------------------
  83
  84 void BmpCreator::ImplCreate( const ::std::vector< DirEntry >& rInDirs,
  85                              const DirEntry& rOut,
  86                              const String& rName,
  87                              const LangInfo& rLang )
  88 {
  89     const sal_uInt32    nOldPos = pSRS->Tell();
  90        const char*         pCollectFile = getenv( "BMP_COLLECT_FILE" );
  91        SvFileStream*       pCollectStm = pCollectFile ? new SvFileStream( String( pCollectFile, RTL_TEXTENCODING_ASCII_US ),
  92                                                                           STREAM_WRITE ) : NULL;
  93
  94     if( pCollectStm )
  95         pCollectStm->Seek( STREAM_SEEK_TO_END );
  96
  97     if( rInDirs.size() )
  98     {
  99         ByteString                  aLine;
 100         String                                  aInfo, aPrefix, aName( rName ), aString;
 101         SvFileStream                    aOutStream;
 102         BitmapEx                                    aTotalBmpEx;
 103         DirEntry                                aOutFile( rOut );
 104         ::std::vector< DirEntry >   aInFiles( rInDirs );
 105         ::std::vector< String >     aNameVector;
 106         sal_uInt32                  i;
 107
 108         for( i = 0; i < aInFiles.size(); i++ )
 109             aInFiles[ i ] += DirEntry( String( RTL_CONSTASCII_USTRINGPARAM( "xxx.xxx" ) ) );
 110
 111         // get prefix for files
 112         if( ( aName.Len() >= 3 ) && ( aName.GetChar( 2 ) != '_' ) )
 113             aPrefix = String( aName, 0, 3 );
 114         else
 115             aPrefix = String( aName, 0, 2 );
 116
 117             String aNumStr( String::CreateFromAscii( rLang.maLangDir )) ;
 118
 119             if( aNumStr.Len() == 1 )
 120                 aNumStr.Insert( '0', 0 );
 121
 122             aName = DirEntry( aName ).GetBase();
 123             aName += String( RTL_CONSTASCII_USTRINGPARAM( ".bmp" ) );
 124
 125         // create output file name
 126         aOutFile += DirEntry( aName );
 127
 128         // get number of bitmaps
 129         while( aLine.Search( '}' ) == STRING_NOTFOUND )
 130         {
 131             if( !pSRS->ReadLine( aLine ) )
 132                 break;
 133
 134             aLine.EraseLeadingChars( ' ' );
 135             aLine.EraseLeadingChars( '\t' );
 136             aLine.EraseAllChars( ';' );
 137
 138             if( aLine.IsNumericAscii() )
 139             {
 140                 aString = aPrefix;
 141
 142                 if( atoi( aLine.GetBuffer() ) < 10000 )
 143                     aString += String::CreateFromInt32( 0 );
 144
 145                 // search for pngs by default
 146                 String aPngString( aString += String( aLine.GetBuffer(), RTL_TEXTENCODING_UTF8 ) );
 147                 aNameVector.push_back( aPngString += String( RTL_CONSTASCII_USTRINGPARAM( ".png" ) ) );
 148            }
 149         }
 150
 151         if( !aNameVector.size() )
 152             Message( String( RTL_CONSTASCII_USTRINGPARAM( "WARNING: No imagelist resource found: " ) ).Append( aString ), EXIT_MISSING_RESOURCE );
 153         else
 154         {
 155             // write info
 156             aInfo = String( RTL_CONSTASCII_USTRINGPARAM( "CREATING ImageList for language: " ) );
 157             aInfo += String( ::rtl::OUString::createFromAscii( rLang.maLangDir ) );
 158             aInfo += String( RTL_CONSTASCII_USTRINGPARAM( " [ " ) );
 159
 160             for( i = 0; i < rInDirs.size(); i++ )
 161                 ( aInfo += rInDirs[ i ].GetFull() ) += String( RTL_CONSTASCII_USTRINGPARAM( "; " ) );
 162
 163             aInfo += String( RTL_CONSTASCII_USTRINGPARAM( " ]" ) );
 164             Message( aInfo );
 165
 166             // create bit vector to hold flags for valid bitmaps
 167             ::std::bit_vector   aValidBmpBitVector( aNameVector.size(), false );
 168             BitmapEx            aBmpEx;
 169
 170             for( sal_uInt32 n = 0; n < aNameVector.size(); n++ )
 171             {
 172                 aBmpEx.SetEmpty();
 173
 174                 for( i = 0; i < aInFiles.size() && aBmpEx.IsEmpty(); i++ )
 175                 {
 176                     DirEntry aInFile( aInFiles[ i ] );
 177
 178                     aInFile.SetName( aString = aNameVector[ n ] );
 179                     bool bPNG = aInFile.Exists();
 180
 181                     if( !bPNG )
 182             {
 183                         aInFile.SetExtension( String( RTL_CONSTASCII_USTRINGPARAM( "bmp" ) ) );
 184             aString = aInFile.GetName();
 185             }
 186
 187                     if( aInFile.Exists() )
 188                     {
 189                         const String    aFileName( aInFile.GetFull() );
 190                         SvFileStream    aIStm( aFileName, STREAM_READ );
 191
 192                         if( bPNG )
 193                         {
 194                             ::vcl::PNGReader aPNGReader( aIStm );
 195                             aBmpEx = aPNGReader.Read();
 196                         }
 197                         else
 198                             aIStm >> aBmpEx;
 199
 200                         if( pCollectStm && !aBmpEx.IsEmpty() )
 201                         {
 202                             const ByteString aCollectString( aFileName, RTL_TEXTENCODING_ASCII_US );
 203                             pCollectStm->WriteLine( aCollectString );
 204                         }
 205                     }
 206                 }
 207
 208                 const Size aSize( aBmpEx.GetSizePixel() );
 209
 210                 if( aBmpEx.IsEmpty() )
 211                 {
 212                     Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: graphic is missing: " ) ).Append( aString ), EXIT_MISSING_BITMAP );
 213                 }
 214                 else
 215                 {
 216                     if( aTotalBmpEx.IsEmpty() )
 217                     {
 218                         // first bitmap determines metrics of total bitmap
 219                         Size aTotalSize( aOneSize = aSize );
 220
 221                         aTotalSize.Width() *= aNameVector.size();
 222                         aTotalBmpEx = Bitmap( aTotalSize, aBmpEx.GetBitmap().GetBitCount() );
 223                     }
 224
 225                     if( ( aSize.Width() > aOneSize.Width() ) || ( aSize.Height() > aOneSize.Height() ) )
 226                          Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: Different dimensions in file: " ) ).Append( aString ), EXIT_DIMENSIONERROR );
 227                     else
 228                     {
 229                         Point           aPoint;
 230                         const Rectangle aDst( Point( aOneSize.Width() * n, 0L ), aSize );
 231                         const Rectangle aSrc( aPoint, aSize );
 232
 233                         if( !aTotalBmpEx.IsEmpty() && !aBmpEx.IsEmpty() && !aDst.IsEmpty() && !aSrc.IsEmpty() )
 234                         {
 235                             if( !aTotalBmpEx.IsTransparent() && aBmpEx.IsTransparent() )
 236                             {
 237                                 const Bitmap aTmpBmp( aTotalBmpEx.GetBitmap() );
 238                                 aTotalBmpEx = BitmapEx( aTmpBmp, AlphaMask( aTmpBmp.CreateMask( COL_LIGHTMAGENTA ) ) );
 239                             }
 240                             else if( aTotalBmpEx.IsTransparent() && !aBmpEx.IsTransparent() )
 241                             {
 242                                 const Bitmap aTmpBmp( aBmpEx.GetBitmap() );
 243                                 aBmpEx = BitmapEx( aTmpBmp, AlphaMask( aTmpBmp.CreateMask( COL_LIGHTMAGENTA ) ) );
 244                             }
 245
 246                             aTotalBmpEx.CopyPixel( aDst, aSrc, &aBmpEx );
 247                             aValidBmpBitVector[ n ] = true;
 248                         }
 249                     }
 250                 }
 251             }
 252
 253             if( !aTotalBmpEx.IsEmpty() )
 254             {
 255                 // do we have invalid bitmaps?
 256                 if( ::std::find( aValidBmpBitVector.begin(), aValidBmpBitVector.end(), false ) != aValidBmpBitVector.end() )
 257                 {
 258                     Bitmap              aTmpBmp( aTotalBmpEx.GetBitmap() );
 259                     BitmapWriteAccess*  pAcc = aTmpBmp.AcquireWriteAccess();
 260
 261                     if( pAcc )
 262                     {
 263                         pAcc->SetLineColor( Color( COL_LIGHTGREEN ) );
 264
 265                         for( sal_uInt32 n = 0; n < aValidBmpBitVector.size(); n++ )
 266                         {
 267                             if( !aValidBmpBitVector[ n ] )
 268                             {
 269                                 const Rectangle aDst( Point( aOneSize.Width() * n, 0L ), aOneSize );
 270
 271                                 pAcc->DrawRect( aDst );
 272                                 pAcc->DrawLine( aDst.TopLeft(), aDst.BottomRight() );
 273                                 pAcc->DrawLine( aDst.TopRight(), aDst.BottomLeft() );
 274                             }
 275                         }
 276
 277                         aTmpBmp.ReleaseAccess( pAcc );
 278
 279                         if( aTotalBmpEx.IsAlpha() )
 280                             aTotalBmpEx = BitmapEx( aTmpBmp, aTotalBmpEx.GetAlpha() );
 281                         else if( aTotalBmpEx.IsTransparent() )
 282                             aTotalBmpEx = BitmapEx( aTmpBmp, aTotalBmpEx.GetMask() );
 283                         else
 284                             aTotalBmpEx = aTmpBmp;
 285                     }
 286                 }
 287
 288                 // write output file
 289                 const String aOutFileName( aOutFile.GetFull() );
 290
 291                 aOutStream.Open( aOutFileName, STREAM_WRITE | STREAM_TRUNC );
 292
 293                 if( !aOutStream.IsOpen() )
 294                     Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: Could not open output file: " ) ).Append( aOutFileName ), EXIT_IOERROR );
 295                 else
 296                 {
 297                     if( aOutFileName.Search( String( RTL_CONSTASCII_USTRINGPARAM( ".png" ) ) ) != STRING_NOTFOUND )
 298                     {
 299                         ::vcl::PNGWriter aPNGWriter( aTotalBmpEx );
 300                         aPNGWriter.Write( aOutStream );
 301                     }
 302                     else
 303                         aOutStream << aTotalBmpEx;
 304
 305                     if( aOutStream.GetError()  )
 306                         Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: Could not write to output file: " ) ).Append( aOutFileName ), EXIT_IOERROR );
 307                     else
 308                         Message( String( RTL_CONSTASCII_USTRINGPARAM( "Successfully generated ImageList " ) ).Append( aOutFileName ) );
 309
 310                     aOutStream.Close();
 311                 }
 312             }
 313             else
 314                 Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: Could not generate  " ) ).Append( aOutFile.GetFull() ), EXIT_COMMONERROR );
 315
 316             Message( ' ' );
 317         }
 318     }
 319     else
 320         Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: SOLARSRC environment variable not set!" ) ), EXIT_MISSING_SOLARSRC_ENV );
 321
 322     pSRS->Seek( nOldPos );
 323     delete pCollectStm;
 324 }
 325
 326 // -----------------------------------------------------------------------------
 327
 328 void BmpCreator::Create( const String& rSRSName,
 329                          const ::std::vector< String >& rInDirs,
 330                          const String& rOutName,
 331                          const LangInfo& rLang )
 332 {
 333     DirEntry                    aFileName( ImplGetSystemFileName( rSRSName ) ), aOutDir( ImplGetSystemFileName( rOutName ) );
 334     ::std::vector< DirEntry >   aInDirs;
 335     BOOL                                bDone = FALSE;
 336
 337     aFileName.ToAbs();
 338     aOutDir.ToAbs();
 339
 340     // create vector of all valid input directories,
 341     // including language subdirectories
 342     for( sal_uInt32 i = 0; i < rInDirs.size(); i++ )
 343     {
 344         DirEntry aInDir( ImplGetSystemFileName( rInDirs[ i ] ) );
 345
 346         aInDir.ToAbs();
 347
 348         if( aInDir.Exists() )
 349         {
 350             DirEntry aLangInDir( aInDir );
 351
 352             if( ( aLangInDir += DirEntry( ::rtl::OUString::createFromAscii( rLang.maLangDir ) ) ).Exists() )
 353                 aInDirs.push_back( aLangInDir );
 354
 355             aInDirs.push_back( aInDir );
 356         }
 357     }
 358
 359     pSRS = new SvFileStream ( aFileName.GetFull(), STREAM_STD_READ );
 360
 361     if( pSRS->GetError() )
 362         Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: Kein SRS file!" ) ), EXIT_NOSRSFILE );
 363     else
 364     {
 365         String          aText;
 366         ByteString      aByteText;
 367         BOOL            bLangDep = FALSE;
 368
 369         do
 370         {
 371             do
 372             {
 373                 if (!pSRS->ReadLine(aByteText))
 374                     break;
 375             }
 376             while ( aByteText.Search( "ImageList" ) == STRING_NOTFOUND );
 377
 378             do
 379             {
 380                 if (!pSRS->ReadLine( aByteText ) )
 381                     break;
 382             }
 383             while ( aByteText.Search( "File" ) == STRING_NOTFOUND );
 384             aText = String::CreateFromAscii( aByteText.GetBuffer() );
 385
 386             const String aName( aText.GetToken( 1, '"' ) );
 387
 388             do
 389             {
 390                 if( !bLangDep &&
 391                     aByteText.Search( "File" ) != STRING_NOTFOUND &&
 392                     aByteText.Search( '[' ) != STRING_NOTFOUND &&
 393                     aByteText.Search( ']' ) != STRING_NOTFOUND )
 394                 {
 395                     bLangDep = TRUE;
 396                 }
 397
 398                 if (!pSRS->ReadLine(aByteText))
 399                     break;
 400             }
 401             while (aByteText.Search( "IdList" ) == STRING_NOTFOUND );
 402             aText = String::CreateFromAscii( aByteText.GetBuffer() );
 403
 404             // if image list is not language dependent, don't do anything for languages except german
 405             if( aText.Len() )
 406             {
 407                 bDone = TRUE;
 408                 ImplCreate( aInDirs, aOutDir, aName, rLang );
 409             }
 410 /*                      else if( ( rLang.mnLangNum != 49 ) && !bLangDep )
 411             {
 412                 Message( String( RTL_CONSTASCII_USTRINGPARAM( "INFO: ImageList is not language dependent! Nothing to do for this language." ) ) );
 413                 bDone = TRUE;
 414             }*/
 415         }
 416         while ( aText.Len() );
 417     }
 418
 419     if( !bDone )
 420         Message( String( RTL_CONSTASCII_USTRINGPARAM( "ERROR: No ImageList found in SRS file!" ) ), EXIT_NOIMGLIST );
 421
 422     delete pSRS;
 423 }