sc/source/filter/excel/xltools.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 <algorithm>
  21 #include <math.h>
  22 #include <string_view>
  23
  24 #include <o3tl/unit_conversion.hxx>
  25 #include <sal/mathconf.h>
  26 #include <sal/macros.h>
  27 #include <sal/log.hxx>
  28 #include <tools/solar.h>
  29 #include <o3tl/string_view.hxx>
  30 #include <unotools/fontdefs.hxx>
  31 #include <filter/msfilter/msvbahelper.hxx>
  32 #include <xestream.hxx>
  33 #include <formula/errorcodes.hxx>
  34 #include <globstr.hrc>
  35 #include <scresid.hxx>
  36 #include <xlstyle.hxx>
  37 #include <xlname.hxx>
  38 #include <xistream.hxx>
  39 #include <xltools.hxx>
  40
  41 // GUID import/export
  42
  43 XclGuid::XclGuid()
  44     : mpnData{}
  45 {
  46 }
  47
  48 XclGuid::XclGuid(
  49         sal_uInt32 nData1, sal_uInt16 nData2, sal_uInt16 nData3,
  50         sal_uInt8 nData41, sal_uInt8 nData42, sal_uInt8 nData43, sal_uInt8 nData44,
  51         sal_uInt8 nData45, sal_uInt8 nData46, sal_uInt8 nData47, sal_uInt8 nData48 )
  52 {
  53     // convert to little endian -> makes streaming easy
  54     UInt32ToSVBT32( nData1, mpnData );
  55     ShortToSVBT16( nData2, mpnData + 4 );
  56     ShortToSVBT16( nData3, mpnData + 6 );
  57     mpnData[  8 ] = nData41;
  58     mpnData[  9 ] = nData42;
  59     mpnData[ 10 ] = nData43;
  60     mpnData[ 11 ] = nData44;
  61     mpnData[ 12 ] = nData45;
  62     mpnData[ 13 ] = nData46;
  63     mpnData[ 14 ] = nData47;
  64     mpnData[ 15 ] = nData48;
  65 }
  66
  67 bool operator==( const XclGuid& rCmp1, const XclGuid& rCmp2 )
  68 {
  69     return ::std::equal( rCmp1.mpnData, std::end( rCmp1.mpnData ), rCmp2.mpnData );
  70 }
  71
  72 XclImpStream& operator>>( XclImpStream& rStrm, XclGuid& rGuid )
  73 {
  74     rStrm.Read( rGuid.mpnData, 16 );     // mpnData always in little endian
  75     return rStrm;
  76 }
  77
  78 XclExpStream& operator<<( XclExpStream& rStrm, const XclGuid& rGuid )
  79 {
  80     rStrm.Write( rGuid.mpnData, 16 );    // mpnData already in little endian
  81     return rStrm;
  82 }
  83
  84 // Excel Tools
  85
  86 // GUID's
  87 const XclGuid XclTools::maGuidStdLink(
  88     0x79EAC9D0, 0xBAF9, 0x11CE, 0x8C, 0x82, 0x00, 0xAA, 0x00, 0x4B, 0xA9, 0x0B );
  89
  90 const XclGuid XclTools::maGuidUrlMoniker(
  91     0x79EAC9E0, 0xBAF9, 0x11CE, 0x8C, 0x82, 0x00, 0xAA, 0x00, 0x4B, 0xA9, 0x0B );
  92
  93 const XclGuid XclTools::maGuidFileMoniker(
  94     0x00000303, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 );
  95
  96 // numeric conversion
  97
  98 double XclTools::GetDoubleFromRK( sal_Int32 nRKValue )
  99 {
 100     sal_math_Double smD{};
 101
 102     if( ::get_flag( nRKValue, EXC_RK_INTFLAG ) )
 103     {
 104         sal_Int32 nTemp = nRKValue >> 2;
 105         ::set_flag< sal_Int32 >( nTemp, 0xE0000000, nRKValue < 0 );
 106         smD.value = nTemp;
 107     }
 108     else
 109     {
 110         smD.w32_parts.msw = nRKValue & EXC_RK_VALUEMASK;
 111     }
 112
 113     if( ::get_flag( nRKValue, EXC_RK_100FLAG ) )
 114         smD.value /= 100.0;
 115
 116     return smD.value;
 117 }
 118
 119 bool XclTools::GetRKFromDouble( sal_Int32& rnRKValue, double fValue )
 120 {
 121     double fFrac, fInt;
 122
 123     // integer
 124     fFrac = modf( fValue, &fInt );
 125     if( (fFrac == 0.0) && (fInt >= -536870912.0) && (fInt <= 536870911.0) ) // 2^29
 126     {
 127         rnRKValue
 128             = static_cast<sal_Int32>(
 129                 static_cast<sal_uInt32>(static_cast<sal_Int32>(fInt)) << 2)
 130             | EXC_RK_INT;
 131         return true;
 132     }
 133
 134     // integer/100
 135     fFrac = modf( fValue * 100.0, &fInt );
 136     if( (fFrac == 0.0) && (fInt >= -536870912.0) && (fInt <= 536870911.0) )
 137     {
 138         rnRKValue
 139             = static_cast<sal_Int32>(
 140                 static_cast<sal_uInt32>(static_cast<sal_Int32>(fInt)) << 2)
 141             | EXC_RK_INT100;
 142         return true;
 143     }
 144
 145     // double
 146     return false;
 147 }
 148
 149 Degree100 XclTools::GetScRotation( sal_uInt16 nXclRot, Degree100 nRotForStacked )
 150 {
 151     if( nXclRot == EXC_ROT_STACKED )
 152         return nRotForStacked;
 153     OSL_ENSURE( nXclRot <= 180, "XclTools::GetScRotation - illegal rotation angle" );
 154     return Degree100(static_cast< sal_Int32 >( (nXclRot <= 180) ? (100 * ((nXclRot > 90) ? (450 - nXclRot) : nXclRot)) : 0 ));
 155 }
 156
 157 sal_uInt8 XclTools::GetXclRotation( Degree100 nScRot )
 158 {
 159     sal_Int32 nXclRot = nScRot.get() / 100;
 160     if( (0 <= nXclRot) && (nXclRot <= 90) )
 161         return static_cast< sal_uInt8 >( nXclRot );
 162     if( nXclRot < 180 )
 163         return static_cast< sal_uInt8 >( 270 - nXclRot );
 164     if( nXclRot < 270 )
 165         return static_cast< sal_uInt8 >( nXclRot - 180 );
 166     if( nXclRot < 360 )
 167         return static_cast< sal_uInt8 >( 450 - nXclRot );
 168     return 0;
 169 }
 170
 171 sal_uInt8 XclTools::GetXclRotFromOrient( sal_uInt8 nXclOrient )
 172 {
 173     switch( nXclOrient )
 174     {
 175         case EXC_ORIENT_NONE:       return EXC_ROT_NONE;
 176         case EXC_ORIENT_STACKED:    return EXC_ROT_STACKED;
 177         case EXC_ORIENT_90CCW:      return EXC_ROT_90CCW;
 178         case EXC_ORIENT_90CW:       return EXC_ROT_90CW;
 179         default:    OSL_FAIL( "XclTools::GetXclRotFromOrient - unknown text orientation" );
 180     }
 181     return EXC_ROT_NONE;
 182 }
 183
 184 sal_uInt8 XclTools::GetXclOrientFromRot( sal_uInt16 nXclRot )
 185 {
 186     if( nXclRot == EXC_ROT_STACKED )
 187         return EXC_ORIENT_STACKED;
 188     OSL_ENSURE( nXclRot <= 180, "XclTools::GetXclOrientFromRot - unknown text rotation" );
 189     if( (45 < nXclRot) && (nXclRot <= 90) )
 190         return EXC_ORIENT_90CCW;
 191     if( (135 < nXclRot) && (nXclRot <= 180) )
 192         return EXC_ORIENT_90CW;
 193     return EXC_ORIENT_NONE;
 194 }
 195
 196 sal_uInt8 XclTools::GetXclErrorCode( FormulaError nScError )
 197 {
 198     switch( nScError )
 199     {
 200         case FormulaError::IllegalArgument:        return EXC_ERR_VALUE;
 201         case FormulaError::IllegalFPOperation:     return EXC_ERR_NUM;     // maybe DIV/0 or NUM...
 202         case FormulaError::DivisionByZero:         return EXC_ERR_DIV0;
 203         case FormulaError::IllegalParameter:       return EXC_ERR_VALUE;
 204         case FormulaError::PairExpected:           return EXC_ERR_VALUE;
 205         case FormulaError::OperatorExpected:       return EXC_ERR_VALUE;
 206         case FormulaError::VariableExpected:       return EXC_ERR_VALUE;
 207         case FormulaError::ParameterExpected:      return EXC_ERR_VALUE;
 208         case FormulaError::NoValue:                return EXC_ERR_VALUE;
 209         case FormulaError::CircularReference:      return EXC_ERR_VALUE;
 210         case FormulaError::NoCode:                 return EXC_ERR_NULL;
 211         case FormulaError::NoRef:                  return EXC_ERR_REF;
 212         case FormulaError::NoName:                 return EXC_ERR_NAME;
 213         case FormulaError::NoAddin:                return EXC_ERR_NAME;
 214         case FormulaError::NoMacro:                return EXC_ERR_NAME;
 215         case FormulaError::NotAvailable:           return EXC_ERR_NA;
 216         default: break;
 217     }
 218     return EXC_ERR_NA;
 219 }
 220
 221 FormulaError XclTools::GetScErrorCode( sal_uInt8 nXclError )
 222 {
 223     switch( nXclError )
 224     {
 225         case EXC_ERR_NULL:  return FormulaError::NoCode;
 226         case EXC_ERR_DIV0:  return FormulaError::DivisionByZero;
 227         case EXC_ERR_VALUE: return FormulaError::NoValue;
 228         case EXC_ERR_REF:   return FormulaError::NoRef;
 229         case EXC_ERR_NAME:  return FormulaError::NoName;
 230         case EXC_ERR_NUM:   return FormulaError::IllegalFPOperation;
 231         case EXC_ERR_NA:    return FormulaError::NotAvailable;
 232         default:            OSL_FAIL( "XclTools::GetScErrorCode - unknown error code" );
 233     }
 234     return FormulaError::NotAvailable;
 235 }
 236
 237 double XclTools::ErrorToDouble( sal_uInt8 nXclError )
 238 {
 239     return CreateDoubleError(GetScErrorCode( nXclError ));
 240 }
 241
 242 XclBoolError XclTools::ErrorToEnum( double& rfDblValue, bool bErrOrBool, sal_uInt8 nValue )
 243 {
 244     XclBoolError eType;
 245     if( bErrOrBool )
 246     {
 247         // error value
 248         switch( nValue )
 249         {
 250             case EXC_ERR_NULL:  eType = xlErrNull;      break;
 251             case EXC_ERR_DIV0:  eType = xlErrDiv0;      break;
 252             case EXC_ERR_VALUE: eType = xlErrValue;     break;
 253             case EXC_ERR_REF:   eType = xlErrRef;       break;
 254             case EXC_ERR_NAME:  eType = xlErrName;      break;
 255             case EXC_ERR_NUM:   eType = xlErrNum;       break;
 256             case EXC_ERR_NA:    eType = xlErrNA;        break;
 257             default:            eType = xlErrUnknown;
 258         }
 259         rfDblValue = 0.0;
 260     }
 261     else
 262     {
 263         // Boolean value
 264         eType = nValue ? xlErrTrue : xlErrFalse;
 265         rfDblValue = nValue ? 1.0 : 0.0;
 266     }
 267     return eType;
 268 }
 269
 270 template <typename N> static N to(double f) { return limit_cast<N>(f + 0.5); }
 271
 272 sal_uInt16 XclTools::GetTwipsFromInch( double fInches )
 273 {
 274     return to<sal_uInt16>(o3tl::convert(fInches, o3tl::Length::in, o3tl::Length::twip));
 275 }
 276
 277 sal_uInt16 XclTools::GetTwipsFromHmm( sal_Int32 nHmm )
 278 {
 279     return limit_cast<sal_uInt16>(o3tl::convert(nHmm, o3tl::Length::mm100, o3tl::Length::twip));
 280 }
 281
 282 double XclTools::GetInchFromTwips( sal_Int32 nTwips )
 283 {
 284     return o3tl::convert<double>(nTwips, o3tl::Length::twip, o3tl::Length::in);
 285 }
 286
 287 double XclTools::GetInchFromHmm( sal_Int32 nHmm )
 288 {
 289     return o3tl::convert<double>(nHmm, o3tl::Length::mm100, o3tl::Length::in);
 290 }
 291
 292 sal_Int32 XclTools::GetHmmFromInch( double fInches )
 293 {
 294     return to<sal_Int32>(o3tl::convert(fInches, o3tl::Length::in, o3tl::Length::mm100));
 295 }
 296
 297 sal_Int32 XclTools::GetHmmFromTwips( sal_Int32 nTwips )
 298 {
 299     return limit_cast<sal_Int32>(o3tl::convert(nTwips, o3tl::Length::twip, o3tl::Length::mm100));
 300 }
 301
 302 sal_uInt16 XclTools::GetScColumnWidth( sal_uInt16 nXclWidth, tools::Long nScCharWidth )
 303 {
 304     double fScWidth = static_cast< double >( nXclWidth ) / 256.0 * nScCharWidth - 0.5;
 305     return limit_cast< sal_uInt16 >( fScWidth );
 306 }
 307
 308 sal_uInt16 XclTools::GetXclColumnWidth( sal_uInt16 nScWidth, tools::Long nScCharWidth )
 309 {
 310     double fXclWidth = ( static_cast< double >( nScWidth ) + 0.5 ) * 256.0 / nScCharWidth;
 311     return limit_cast< sal_uInt16 >( fXclWidth );
 312 }
 313
 314 // takes font height in twips (1/20 pt = 1/1440 in)
 315 // returns correction value in 1/256th of *digit width* of default font
 316 double XclTools::GetXclDefColWidthCorrection( tools::Long nXclDefFontHeight )
 317 {
 318     // Excel uses *max digit width of default font* (W) as cell width unit. Also it has 5-pixel
 319     // "correction" to cell widths (ECMA-376-1:2016 18.3.1.81): each cell has 1-pixel padding, then
 320     // 3 pixels for the border (which may be 1-pixel - hairline - then it will have 2 additional
 321     // 1-pixel spacings from each side; or e.g. 2 hairlines with 1-pixel spacing in the middle; or
 322     // thick 3-pixel). Obviously, correction size entirely depends on pixel size (and it is actually
 323     // different in Excel on monitors with different resolution). Thus actual (displayed/printed)
 324     // cell widths consist of X*W+5px; stored in file is the X (or X*256 if 1/256th of digit width
 325     // units are used) value.
 326     // This formula apparently converts this 5-pixel correction to 1/256th of digit width units.
 327     // Looks like it is created from
 328     //
 329     //    5 * 256 * 1440 * 2.1333 / (96 * max(N-15, 60)) + 50.0
 330     //
 331     // where 5 - pixel correction; 256 - used to produce 1/256th of digit width; 1440 - used to
 332     // convert font height N (in twips) to inches; 2.1333 - an (empirical?) quotient to convert
 333     // font *height* into digit *width*; 96 - "standard" monitor resolution (DPI).
 334     // Additionally the formula uses 15 (of unknown origin), 60 (minimal font height 3 pt), and
 335     // 50.0 (also of unknown origin).
 336     //
 337     // TODO: convert this to take font digit width directly (and possibly DPI?), to avoid guessing
 338     // the digit width and pixel size. Or DPI might stay 96, to not follow Excel dependency on DPI
 339     // in addition to used font, and have absolute size of the correction fixed 5/96 in.
 340     return 40960.0 / ::std::max( nXclDefFontHeight - 15, tools::Long(60) ) + 50.0;
 341 }
 342
 343 // formatting
 344
 345 Color XclTools::GetPatternColor( const Color& rPattColor, const Color& rBackColor, sal_uInt16 nXclPattern )
 346 {
 347     // 0x00 == 0% transparence (full rPattColor)
 348     // 0x80 == 100% transparence (full rBackColor)
 349     static const sal_uInt8 pnRatioTable[] =
 350     {
 351         0x80, 0x00, 0x40, 0x20, 0x60, 0x40, 0x40, 0x40,     // 00 - 07
 352         0x40, 0x40, 0x20, 0x60, 0x60, 0x60, 0x60, 0x48,     // 08 - 15
 353         0x50, 0x70, 0x78                                    // 16 - 18
 354     };
 355     return (nXclPattern < std::size( pnRatioTable )) ?
 356         ScfTools::GetMixedColor( rPattColor, rBackColor, pnRatioTable[ nXclPattern ] ) : rPattColor;
 357 }
 358
 359 // text encoding
 360
 361 namespace {
 362
 363 const struct XclCodePageEntry
 364 {
 365     sal_uInt16                  mnCodePage;
 366     rtl_TextEncoding            meTextEnc;
 367 }
 368 pCodePageTable[] =
 369 {
 370     {     437,  RTL_TEXTENCODING_IBM_437        },  // OEM US
 371 //  {     720,  RTL_TEXTENCODING_IBM_720        },  // OEM Arabic
 372     {     737,  RTL_TEXTENCODING_IBM_737        },  // OEM Greek
 373     {     775,  RTL_TEXTENCODING_IBM_775        },  // OEM Baltic
 374     {     850,  RTL_TEXTENCODING_IBM_850        },  // OEM Latin I
 375     {     852,  RTL_TEXTENCODING_IBM_852        },  // OEM Latin II (Central European)
 376     {     855,  RTL_TEXTENCODING_IBM_855        },  // OEM Cyrillic
 377     {     857,  RTL_TEXTENCODING_IBM_857        },  // OEM Turkish
 378 //  {     858,  RTL_TEXTENCODING_IBM_858        },  // OEM Multilingual Latin I with Euro
 379     {     860,  RTL_TEXTENCODING_IBM_860        },  // OEM Portuguese
 380     {     861,  RTL_TEXTENCODING_IBM_861        },  // OEM Icelandic
 381     {     862,  RTL_TEXTENCODING_IBM_862        },  // OEM Hebrew
 382     {     863,  RTL_TEXTENCODING_IBM_863        },  // OEM Canadian (French)
 383     {     864,  RTL_TEXTENCODING_IBM_864        },  // OEM Arabic
 384     {     865,  RTL_TEXTENCODING_IBM_865        },  // OEM Nordic
 385     {     866,  RTL_TEXTENCODING_IBM_866        },  // OEM Cyrillic (Russian)
 386     {     869,  RTL_TEXTENCODING_IBM_869        },  // OEM Greek (Modern)
 387     {     874,  RTL_TEXTENCODING_MS_874         },  // MS Windows Thai
 388     {     932,  RTL_TEXTENCODING_MS_932         },  // MS Windows Japanese Shift-JIS
 389     {     936,  RTL_TEXTENCODING_MS_936         },  // MS Windows Chinese Simplified GBK
 390     {     949,  RTL_TEXTENCODING_MS_949         },  // MS Windows Korean (Wansung)
 391     {     950,  RTL_TEXTENCODING_MS_950         },  // MS Windows Chinese Traditional BIG5
 392     {    1200,  RTL_TEXTENCODING_DONTKNOW       },  // Unicode (BIFF8) - return *_DONTKNOW to preserve old code page
 393     {    1250,  RTL_TEXTENCODING_MS_1250        },  // MS Windows Latin II (Central European)
 394     {    1251,  RTL_TEXTENCODING_MS_1251        },  // MS Windows Cyrillic
 395     {    1252,  RTL_TEXTENCODING_MS_1252        },  // MS Windows Latin I (BIFF4-BIFF8)
 396     {    1253,  RTL_TEXTENCODING_MS_1253        },  // MS Windows Greek
 397     {    1254,  RTL_TEXTENCODING_MS_1254        },  // MS Windows Turkish
 398     {    1255,  RTL_TEXTENCODING_MS_1255        },  // MS Windows Hebrew
 399     {    1256,  RTL_TEXTENCODING_MS_1256        },  // MS Windows Arabic
 400     {    1257,  RTL_TEXTENCODING_MS_1257        },  // MS Windows Baltic
 401     {    1258,  RTL_TEXTENCODING_MS_1258        },  // MS Windows Vietnamese
 402     {    1361,  RTL_TEXTENCODING_MS_1361        },  // MS Windows Korean (Johab)
 403     {   10000,  RTL_TEXTENCODING_APPLE_ROMAN    },  // Apple Roman
 404     {   32768,  RTL_TEXTENCODING_APPLE_ROMAN    },  // Apple Roman
 405     {   32769,  RTL_TEXTENCODING_MS_1252        }   // MS Windows Latin I (BIFF2-BIFF3)
 406 };
 407 const XclCodePageEntry* const pCodePageTableEnd = std::end(pCodePageTable);
 408
 409 struct XclCodePageEntry_CPPred
 410 {
 411     explicit     XclCodePageEntry_CPPred( sal_uInt16 nCodePage ) : mnCodePage( nCodePage ) {}
 412     bool         operator()( const XclCodePageEntry& rEntry ) const { return rEntry.mnCodePage == mnCodePage; }
 413     sal_uInt16          mnCodePage;
 414 };
 415
 416 struct XclCodePageEntry_TEPred
 417 {
 418     explicit     XclCodePageEntry_TEPred( rtl_TextEncoding eTextEnc ) : meTextEnc( eTextEnc ) {}
 419     bool         operator()( const XclCodePageEntry& rEntry ) const { return rEntry.meTextEnc == meTextEnc; }
 420     rtl_TextEncoding    meTextEnc;
 421 };
 422
 423 } // namespace
 424
 425 rtl_TextEncoding XclTools::GetTextEncoding( sal_uInt16 nCodePage )
 426 {
 427     const XclCodePageEntry* pEntry = ::std::find_if( pCodePageTable, pCodePageTableEnd, XclCodePageEntry_CPPred( nCodePage ) );
 428     if( pEntry == pCodePageTableEnd )
 429     {
 430         SAL_WARN("sc",  "XclTools::GetTextEncoding - unknown code page: 0x" << std::hex << nCodePage );
 431         return RTL_TEXTENCODING_DONTKNOW;
 432     }
 433     return pEntry->meTextEnc;
 434 }
 435
 436 sal_uInt16 XclTools::GetXclCodePage( rtl_TextEncoding eTextEnc )
 437 {
 438     if( eTextEnc == RTL_TEXTENCODING_UNICODE )
 439         return 1200;    // for BIFF8
 440
 441     const XclCodePageEntry* pEntry = ::std::find_if( pCodePageTable, pCodePageTableEnd, XclCodePageEntry_TEPred( eTextEnc ) );
 442     if( pEntry == pCodePageTableEnd )
 443     {
 444         SAL_WARN("sc",  "XclTools::GetXclCodePage - unsupported text encoding: 0x" << std::hex << eTextEnc );
 445         return 1252;
 446     }
 447     return pEntry->mnCodePage;
 448 }
 449
 450 OUString XclTools::GetXclFontName( const OUString& rFontName )
 451 {
 452     // substitute with MS fonts
 453     OUString aNewName = GetSubsFontName(rFontName, SubsFontFlags::ONLYONE | SubsFontFlags::MS);
 454     return aNewName.isEmpty() ? rFontName : aNewName;
 455 }
 456
 457 // built-in defined names
 458 const char maDefNamePrefix[]    = "Excel_BuiltIn_"; /// Prefix for built-in defined names.
 459 const char maDefNamePrefixXml[] = "_xlnm.";         /// Prefix for built-in defined names for OOX
 460
 461 const char* const ppcDefNames[] =
 462 {
 463     "Consolidate_Area",
 464     "Auto_Open",
 465     "Auto_Close",
 466     "Extract",
 467     "Database",
 468     "Criteria",
 469     "Print_Area",
 470     "Print_Titles",
 471     "Recorder",
 472     "Data_Form",
 473     "Auto_Activate",
 474     "Auto_Deactivate",
 475     "Sheet_Title",
 476     "_FilterDatabase"
 477 };
 478
 479 OUString XclTools::GetXclBuiltInDefName( sal_Unicode cBuiltIn )
 480 {
 481     OSL_ENSURE( std::size( ppcDefNames ) == EXC_BUILTIN_UNKNOWN,
 482         "XclTools::GetXclBuiltInDefName - built-in defined name list modified" );
 483
 484     if( cBuiltIn < std::size( ppcDefNames ) )
 485         return OUString::createFromAscii(ppcDefNames[cBuiltIn]);
 486     else
 487         return OUString::number(cBuiltIn);
 488 }
 489
 490 OUString XclTools::GetBuiltInDefName( sal_Unicode cBuiltIn )
 491 {
 492     return maDefNamePrefix + GetXclBuiltInDefName(cBuiltIn);
 493 }
 494
 495 OUString XclTools::GetBuiltInDefNameXml( sal_Unicode cBuiltIn )
 496 {
 497     return maDefNamePrefixXml + GetXclBuiltInDefName(cBuiltIn);
 498 }
 499
 500 sal_Unicode XclTools::GetBuiltInDefNameIndex( const OUString& rDefName )
 501 {
 502     sal_Int32 nPrefixLen = 0;
 503     if( rDefName.startsWithIgnoreAsciiCase( maDefNamePrefix ) )
 504         nPrefixLen = strlen(maDefNamePrefix);
 505     else if( rDefName.startsWithIgnoreAsciiCase( maDefNamePrefixXml ) )
 506         nPrefixLen = strlen(maDefNamePrefixXml);
 507     if( nPrefixLen > 0 )
 508     {
 509         for( sal_Unicode cBuiltIn = 0; cBuiltIn < EXC_BUILTIN_UNKNOWN; ++cBuiltIn )
 510         {
 511             OUString aBuiltInName(GetXclBuiltInDefName(cBuiltIn));
 512             sal_Int32 nBuiltInLen = aBuiltInName.getLength();
 513             if( rDefName.matchIgnoreAsciiCase( aBuiltInName, nPrefixLen ) )
 514             {
 515                 // name can be followed by underline or space character
 516                 sal_Int32 nNextCharPos = nPrefixLen + nBuiltInLen;
 517                 sal_Unicode cNextChar = (rDefName.getLength() > nNextCharPos) ? rDefName[nNextCharPos] : '\0';
 518                 if( (cNextChar == '\0') || (cNextChar == ' ') || (cNextChar == '_') )
 519                     return cBuiltIn;
 520             }
 521         }
 522     }
 523     return EXC_BUILTIN_UNKNOWN;
 524 }
 525
 526 // built-in style names
 527
 528 const char maStyleNamePrefix1[] = "Excel_BuiltIn_";  /// Prefix for built-in cell style names.
 529 const char maStyleNamePrefix2[] = "Excel Built-in "; /// Prefix for built-in cell style names from OOX filter.
 530
 531 const char* const ppcStyleNames[] =
 532 {
 533     "",                 // "Normal" not used directly, but localized "Default"
 534     "RowLevel_",        // outline level will be appended
 535     "ColumnLevel_",     // outline level will be appended
 536     "Comma",
 537     "Currency",
 538     "Percent",
 539     "Comma_0",
 540     "Currency_0",
 541     "Hyperlink",
 542     "Followed_Hyperlink"
 543 };
 544
 545 OUString XclTools::GetBuiltInStyleName( sal_uInt8 nStyleId, std::u16string_view rName, sal_uInt8 nLevel )
 546 {
 547     OUString aStyleName;
 548
 549     if( nStyleId == EXC_STYLE_NORMAL )  // "Normal" becomes "Default" style
 550     {
 551         aStyleName = ScResId( STR_STYLENAME_STANDARD );
 552     }
 553     else
 554     {
 555         OUStringBuffer aBuf(maStyleNamePrefix1);
 556         if( nStyleId < std::size( ppcStyleNames ) )
 557             aBuf.appendAscii(ppcStyleNames[nStyleId]);
 558         else if (!rName.empty())
 559             aBuf.append(rName);
 560         else
 561             aBuf.append(static_cast<sal_Int32>(nStyleId));
 562
 563         if( (nStyleId == EXC_STYLE_ROWLEVEL) || (nStyleId == EXC_STYLE_COLLEVEL) )
 564             aBuf.append(static_cast<sal_Int32>(nLevel+1));
 565
 566         aStyleName = aBuf.makeStringAndClear();
 567     }
 568
 569     return aStyleName;
 570 }
 571
 572 bool XclTools::IsBuiltInStyleName( const OUString& rStyleName, sal_uInt8* pnStyleId, sal_Int32* pnNextChar )
 573 {
 574     // "Default" becomes "Normal"
 575     if (rStyleName == ScResId(STR_STYLENAME_STANDARD))
 576     {
 577         if( pnStyleId ) *pnStyleId = EXC_STYLE_NORMAL;
 578         if( pnNextChar ) *pnNextChar = rStyleName.getLength();
 579         return true;
 580     }
 581
 582     // try the other built-in styles
 583     sal_uInt8 nFoundId = 0;
 584     sal_Int32 nNextChar = 0;
 585
 586     sal_Int32 nPrefixLen = 0;
 587     if( rStyleName.startsWithIgnoreAsciiCase( maStyleNamePrefix1 ) )
 588         nPrefixLen = strlen(maStyleNamePrefix1);
 589     else if( rStyleName.startsWithIgnoreAsciiCase( maStyleNamePrefix2 ) )
 590         nPrefixLen = strlen(maStyleNamePrefix2);
 591     if( nPrefixLen > 0 )
 592     {
 593         for( sal_uInt8 nId = 0; nId < std::size( ppcStyleNames ); ++nId )
 594         {
 595             if( nId != EXC_STYLE_NORMAL )
 596             {
 597                 OUString aShortName = OUString::createFromAscii(ppcStyleNames[nId]);
 598                 if( rStyleName.matchIgnoreAsciiCase( aShortName, nPrefixLen ) &&
 599                     (nNextChar < nPrefixLen + aShortName.getLength()))
 600                 {
 601                     nFoundId = nId;
 602                     nNextChar = nPrefixLen + aShortName.getLength();
 603                 }
 604             }
 605         }
 606     }
 607
 608     if( nNextChar > 0 )
 609     {
 610         if( pnStyleId ) *pnStyleId = nFoundId;
 611         if( pnNextChar ) *pnNextChar = nNextChar;
 612         return true;
 613     }
 614
 615     if( pnStyleId ) *pnStyleId = EXC_STYLE_USERDEF;
 616     if( pnNextChar ) *pnNextChar = 0;
 617     return nPrefixLen > 0;  // also return true for unknown built-in styles
 618 }
 619
 620 bool XclTools::GetBuiltInStyleId( sal_uInt8& rnStyleId, sal_uInt8& rnLevel, const OUString& rStyleName )
 621 {
 622     sal_uInt8 nStyleId;
 623     sal_Int32 nNextChar;
 624     if( IsBuiltInStyleName( rStyleName, &nStyleId, &nNextChar ) && (nStyleId != EXC_STYLE_USERDEF) )
 625     {
 626         if( (nStyleId == EXC_STYLE_ROWLEVEL) || (nStyleId == EXC_STYLE_COLLEVEL) )
 627         {
 628             std::u16string_view aLevel = rStyleName.subView(nNextChar);
 629             sal_Int32 nLevel = o3tl::toInt32(aLevel);
 630             if (std::u16string_view(OUString::number(nLevel)) == aLevel
 631                 && nLevel > 0 && nLevel <= EXC_STYLE_LEVELCOUNT)
 632             {
 633                 rnStyleId = nStyleId;
 634                 rnLevel = static_cast< sal_uInt8 >( nLevel - 1 );
 635                 return true;
 636             }
 637         }
 638         else if( rStyleName.getLength() == nNextChar )
 639         {
 640             rnStyleId = nStyleId;
 641             rnLevel = EXC_STYLE_NOLEVEL;
 642             return true;
 643         }
 644     }
 645
 646     rnStyleId = EXC_STYLE_USERDEF;
 647     rnLevel = EXC_STYLE_NOLEVEL;
 648     return false;
 649 }
 650
 651 // conditional formatting style names
 652
 653 const char maCFStyleNamePrefix1[] = "Excel_CondFormat_"; /// Prefix for cond. formatting style names.
 654 const char maCFStyleNamePrefix2[] = "ConditionalStyle_"; /// Prefix for cond. formatting style names from OOX filter.
 655 const char maCFStyleNamePrefix3[] = "ExtConditionalStyle_";
 656
 657 OUString XclTools::GetCondFormatStyleName( SCTAB nScTab, sal_Int32 nFormat, sal_uInt16 nCondition )
 658 {
 659     return maCFStyleNamePrefix1 +
 660         OUString::number(static_cast<sal_Int32>(nScTab+1)) +
 661         "_" +
 662         OUString::number(static_cast<sal_Int32>(nFormat+1)) +
 663         "_" +
 664         OUString::number(static_cast<sal_Int32>(nCondition+1));
 665 }
 666
 667 bool XclTools::IsCondFormatStyleName( const OUString& rStyleName )
 668 {
 669     if( rStyleName.startsWithIgnoreAsciiCase( maCFStyleNamePrefix1 ) )
 670         return true;
 671
 672     if( rStyleName.startsWithIgnoreAsciiCase( maCFStyleNamePrefix2 ) )
 673         return true;
 674
 675     if (rStyleName.startsWithIgnoreAsciiCase(maCFStyleNamePrefix3))
 676         return true;
 677
 678     return false;
 679 }
 680
 681 // stream handling
 682
 683 void XclTools::SkipSubStream( XclImpStream& rStrm )
 684 {
 685     bool bLoop = true;
 686     while( bLoop && rStrm.StartNextRecord() )
 687     {
 688         sal_uInt16 nRecId = rStrm.GetRecId();
 689         bLoop = nRecId != EXC_ID_EOF;
 690         if( (nRecId == EXC_ID2_BOF) || (nRecId == EXC_ID3_BOF) || (nRecId == EXC_ID4_BOF) || (nRecId == EXC_ID5_BOF) )
 691             SkipSubStream( rStrm );
 692     }
 693 }
 694
 695 // Basic macro names
 696
 697 const char maSbMacroPrefix[] = "vnd.sun.star.script:";              /// Prefix for StarBasic macros.
 698 const char maSbMacroSuffix[] = "?language=Basic&location=document"; /// Suffix for StarBasic macros.
 699
 700 OUString XclTools::GetSbMacroUrl( const OUString& rMacroName, SfxObjectShell* pDocShell )
 701 {
 702     OSL_ENSURE( !rMacroName.isEmpty(), "XclTools::GetSbMacroUrl - macro name is empty" );
 703     ::ooo::vba::MacroResolvedInfo aMacroInfo = ::ooo::vba::resolveVBAMacro( pDocShell, rMacroName );
 704     if( aMacroInfo.mbFound )
 705         return ::ooo::vba::makeMacroURL( aMacroInfo.msResolvedMacro );
 706     return OUString();
 707 }
 708
 709 OUString XclTools::GetXclMacroName( const OUString& rSbMacroUrl )
 710 {
 711     sal_Int32 nSbMacroUrlLen = rSbMacroUrl.getLength();
 712     sal_Int32 nMacroNameLen = nSbMacroUrlLen - strlen(maSbMacroPrefix) - strlen(maSbMacroSuffix);
 713     if( (nMacroNameLen > 0) && rSbMacroUrl.startsWithIgnoreAsciiCase( maSbMacroPrefix ) &&
 714             rSbMacroUrl.endsWithIgnoreAsciiCase( maSbMacroSuffix ) )
 715     {
 716         sal_Int32 nPrjDot = rSbMacroUrl.indexOf( '.', strlen(maSbMacroPrefix) ) + 1;
 717         return rSbMacroUrl.copy( nPrjDot, nSbMacroUrlLen - nPrjDot - strlen(maSbMacroSuffix) );
 718     }
 719     return OUString();
 720 }
 721
 722 // read/write colors
 723
 724 XclImpStream& operator>>( XclImpStream& rStrm, Color& rColor )
 725 {
 726     sal_uInt8 nR = rStrm.ReaduInt8();
 727     sal_uInt8 nG = rStrm.ReaduInt8();
 728     sal_uInt8 nB = rStrm.ReaduInt8();
 729     rStrm.Ignore( 1 );//nD
 730     rColor = Color( nR, nG, nB );
 731     return rStrm;
 732 }
 733
 734 XclExpStream& operator<<( XclExpStream& rStrm, const Color& rColor )
 735 {
 736     return rStrm << rColor.GetRed() << rColor.GetGreen() << rColor.GetBlue() << sal_uInt8( 0 );
 737 }
 738
 739 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */