chart2/source/tools/XMLRangeHelper.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: XMLRangeHelper.cxx,v $
  10  * $Revision: 1.4 $
  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_chart2.hxx"
  33
  34 #include "XMLRangeHelper.hxx"
  35 #include <unotools/charclass.hxx>
  36 #include <rtl/ustrbuf.hxx>
  37
  38 #include <algorithm>
  39 #include <functional>
  40
  41 using ::rtl::OUString;
  42 using ::rtl::OUStringBuffer;
  43
  44 // ================================================================================
  45
  46 namespace
  47 {
  48 /** unary function that escapes backslashes and single quotes in a sal_Unicode
  49     array (which you can get from an OUString with getStr()) and puts the result
  50     into the OUStringBuffer given in the CTOR
  51  */
  52 class lcl_Escape : public ::std::unary_function< sal_Unicode, void >
  53 {
  54 public:
  55     lcl_Escape( ::rtl::OUStringBuffer & aResultBuffer ) : m_aResultBuffer( aResultBuffer ) {}
  56     void operator() ( sal_Unicode aChar )
  57     {
  58         static const sal_Unicode m_aQuote( '\'' );
  59         static const sal_Unicode m_aBackslash( '\\' );
  60
  61         if( aChar == m_aQuote ||
  62             aChar == m_aBackslash )
  63             m_aResultBuffer.append( m_aBackslash );
  64         m_aResultBuffer.append( aChar );
  65     }
  66
  67 private:
  68     ::rtl::OUStringBuffer & m_aResultBuffer;
  69 };
  70
  71 // ----------------------------------------
  72
  73 /** unary function that removes backslash escapes in a sal_Unicode array (which
  74     you can get from an OUString with getStr()) and puts the result into the
  75     OUStringBuffer given in the CTOR
  76  */
  77 class lcl_UnEscape : public ::std::unary_function< sal_Unicode, void >
  78 {
  79 public:
  80     lcl_UnEscape( ::rtl::OUStringBuffer & aResultBuffer ) : m_aResultBuffer( aResultBuffer ) {}
  81     void operator() ( sal_Unicode aChar )
  82     {
  83         static const sal_Unicode m_aBackslash( '\\' );
  84
  85         if( aChar != m_aBackslash )
  86             m_aResultBuffer.append( aChar );
  87     }
  88
  89 private:
  90     ::rtl::OUStringBuffer & m_aResultBuffer;
  91 };
  92
  93 // ----------------------------------------
  94
  95 OUStringBuffer lcl_getXMLStringForCell( const ::chart::XMLRangeHelper::Cell & rCell )
  96 {
  97     ::rtl::OUStringBuffer aBuffer;
  98     if( rCell.empty())
  99         return aBuffer;
 100
 101     sal_Int32 nCol = rCell.nColumn;
 102     aBuffer.append( (sal_Unicode)'.' );
 103     if( ! rCell.bRelativeColumn )
 104         aBuffer.append( (sal_Unicode)'$' );
 105
 106     // get A, B, C, ..., AA, AB, ... representation of column number
 107     if( nCol < 26 )
 108         aBuffer.append( (sal_Unicode)('A' + nCol) );
 109     else if( nCol < 702 )
 110     {
 111         aBuffer.append( (sal_Unicode)('A' + nCol / 26 - 1 ));
 112         aBuffer.append( (sal_Unicode)('A' + nCol % 26) );
 113     }
 114     else    // works for nCol <= 18,278
 115     {
 116         aBuffer.append( (sal_Unicode)('A' + nCol / 702 - 1 ));
 117         aBuffer.append( (sal_Unicode)('A' + (nCol % 702) / 26 ));
 118         aBuffer.append( (sal_Unicode)('A' + nCol % 26) );
 119     }
 120
 121     // write row number as number
 122     if( ! rCell.bRelativeRow )
 123         aBuffer.append( (sal_Unicode)'$' );
 124     aBuffer.append( rCell.nRow + (sal_Int32)1 );
 125
 126     return aBuffer;
 127 }
 128
 129 void lcl_getSingleCellAddressFromXMLString(
 130     const ::rtl::OUString& rXMLString,
 131     sal_Int32 nStartPos, sal_Int32 nEndPos,
 132     ::chart::XMLRangeHelper::Cell & rOutCell )
 133 {
 134     // expect "\$?[a-zA-Z]+\$?[1-9][0-9]*"
 135     static const sal_Unicode aDollar( '$' );
 136     static const sal_Unicode aLetterA( 'A' );
 137
 138     ::rtl::OUString aCellStr = rXMLString.copy( nStartPos, nEndPos - nStartPos + 1 ).toAsciiUpperCase();
 139     const sal_Unicode* pStrArray = aCellStr.getStr();
 140     sal_Int32 nLength = aCellStr.getLength();
 141     sal_Int32 i = nLength - 1, nColumn = 0;
 142
 143     // parse number for row
 144     while( CharClass::isAsciiDigit( pStrArray[ i ] ) && i >= 0 )
 145         i--;
 146     rOutCell.nRow = (aCellStr.copy( i + 1 )).toInt32() - 1;
 147     // a dollar in XML means absolute (whereas in UI it means relative)
 148     if( pStrArray[ i ] == aDollar )
 149     {
 150         i--;
 151         rOutCell.bRelativeRow = false;
 152     }
 153     else
 154         rOutCell.bRelativeRow = true;
 155
 156     // parse rest for column
 157     sal_Int32 nPower = 1;
 158     while( CharClass::isAsciiAlpha( pStrArray[ i ] ))
 159     {
 160         nColumn += (pStrArray[ i ] - aLetterA + 1) * nPower;
 161         i--;
 162         nPower *= 26;
 163     }
 164     rOutCell.nColumn = nColumn - 1;
 165
 166     rOutCell.bRelativeColumn = true;
 167     if( i >= 0 &&
 168         pStrArray[ i ] == aDollar )
 169         rOutCell.bRelativeColumn = false;
 170     rOutCell.bIsEmpty = false;
 171 }
 172
 173 bool lcl_getCellAddressFromXMLString(
 174     const ::rtl::OUString& rXMLString,
 175     sal_Int32 nStartPos, sal_Int32 nEndPos,
 176     ::chart::XMLRangeHelper::Cell & rOutCell,
 177     ::rtl::OUString& rOutTableName )
 178 {
 179     static const sal_Unicode aDot( '.' );
 180     static const sal_Unicode aQuote( '\'' );
 181     static const sal_Unicode aBackslash( '\\' );
 182
 183     sal_Int32 nNextDelimiterPos = nStartPos;
 184
 185     sal_Int32 nDelimiterPos = nStartPos;
 186     bool bInQuotation = false;
 187     // parse table name
 188     while( nDelimiterPos < nEndPos &&
 189            ( bInQuotation || rXMLString[ nDelimiterPos ] != aDot ))
 190     {
 191         // skip escaped characters (with backslash)
 192         if( rXMLString[ nDelimiterPos ] == aBackslash )
 193             ++nDelimiterPos;
 194         // toggle quotation mode when finding single quotes
 195         else if( rXMLString[ nDelimiterPos ] == aQuote )
 196             bInQuotation = ! bInQuotation;
 197
 198         ++nDelimiterPos;
 199     }
 200
 201     if( nDelimiterPos == -1 )
 202         return false;
 203
 204     if( nDelimiterPos > nStartPos && nDelimiterPos < nEndPos )
 205     {
 206         // there is a table name before the address
 207
 208         ::rtl::OUStringBuffer aTableNameBuffer;
 209         const sal_Unicode * pTableName = rXMLString.getStr();
 210
 211         // remove escapes from table name
 212         ::std::for_each( pTableName + nStartPos,
 213                          pTableName + nDelimiterPos,
 214                          lcl_UnEscape( aTableNameBuffer ));
 215
 216         // unquote quoted table name
 217         const sal_Unicode * pBuf = aTableNameBuffer.getStr();
 218         if( pBuf[ 0 ] == aQuote &&
 219             pBuf[ aTableNameBuffer.getLength() - 1 ] == aQuote )
 220         {
 221             ::rtl::OUString aName = aTableNameBuffer.makeStringAndClear();
 222             rOutTableName = aName.copy( 1, aName.getLength() - 2 );
 223         }
 224         else
 225             rOutTableName = aTableNameBuffer.makeStringAndClear();
 226     }
 227     else
 228         nDelimiterPos = nStartPos;
 229
 230     for( sal_Int32 i = 0;
 231          nNextDelimiterPos < nEndPos;
 232          nDelimiterPos = nNextDelimiterPos, i++ )
 233     {
 234         nNextDelimiterPos = rXMLString.indexOf( aDot, nDelimiterPos + 1 );
 235         if( nNextDelimiterPos == -1 ||
 236             nNextDelimiterPos > nEndPos )
 237             nNextDelimiterPos = nEndPos + 1;
 238
 239         if( i==0 )
 240             // only take first cell
 241             lcl_getSingleCellAddressFromXMLString(
 242                 rXMLString, nDelimiterPos + 1, nNextDelimiterPos - 1, rOutCell );
 243     }
 244
 245     return true;
 246 }
 247
 248 bool lcl_getCellRangeAddressFromXMLString(
 249     const ::rtl::OUString& rXMLString,
 250     sal_Int32 nStartPos, sal_Int32 nEndPos,
 251     ::chart::XMLRangeHelper::CellRange & rOutRange )
 252 {
 253     bool bResult = true;
 254     static const sal_Unicode aColon( ':' );
 255     static const sal_Unicode aQuote( '\'' );
 256     static const sal_Unicode aBackslash( '\\' );
 257
 258     sal_Int32 nDelimiterPos = nStartPos;
 259     bool bInQuotation = false;
 260     // parse table name
 261     while( nDelimiterPos < nEndPos &&
 262            ( bInQuotation || rXMLString[ nDelimiterPos ] != aColon ))
 263     {
 264         // skip escaped characters (with backslash)
 265         if( rXMLString[ nDelimiterPos ] == aBackslash )
 266             ++nDelimiterPos;
 267         // toggle quotation mode when finding single quotes
 268         else if( rXMLString[ nDelimiterPos ] == aQuote )
 269             bInQuotation = ! bInQuotation;
 270
 271         ++nDelimiterPos;
 272     }
 273
 274     if( nDelimiterPos == nEndPos )
 275     {
 276         // only one cell
 277         bResult = lcl_getCellAddressFromXMLString( rXMLString, nStartPos, nEndPos,
 278                                                    rOutRange.aUpperLeft,
 279                                                    rOutRange.aTableName );
 280         if( !rOutRange.aTableName.getLength() )
 281             bResult = false;
 282     }
 283     else
 284     {
 285         // range (separated by a colon)
 286         bResult = lcl_getCellAddressFromXMLString( rXMLString, nStartPos, nDelimiterPos - 1,
 287                                                    rOutRange.aUpperLeft,
 288                                                    rOutRange.aTableName );
 289         if( !rOutRange.aTableName.getLength() )
 290             bResult = false;
 291
 292         ::rtl::OUString sTableSecondName;
 293         if( bResult )
 294         {
 295             bResult = lcl_getCellAddressFromXMLString( rXMLString, nDelimiterPos + 1, nEndPos,
 296                                                        rOutRange.aLowerRight,
 297                                                        sTableSecondName );
 298         }
 299         if( bResult &&
 300             sTableSecondName.getLength() &&
 301             ! sTableSecondName.equals( rOutRange.aTableName ))
 302             bResult = false;
 303     }
 304
 305     return bResult;
 306 }
 307
 308 } // anonymous namespace
 309
 310 // ================================================================================
 311
 312 namespace chart
 313 {
 314 namespace XMLRangeHelper
 315 {
 316
 317 CellRange getCellRangeFromXMLString( const OUString & rXMLString )
 318 {
 319     static const sal_Unicode aSpace( ' ' );
 320     static const sal_Unicode aQuote( '\'' );
 321 //     static const sal_Unicode aDoubleQuote( '\"' );
 322     static const sal_Unicode aDollar( '$' );
 323     static const sal_Unicode aBackslash( '\\' );
 324
 325     sal_Int32 nStartPos = 0;
 326     sal_Int32 nEndPos = nStartPos;
 327     const sal_Int32 nLength = rXMLString.getLength();
 328
 329     // reset
 330     CellRange aResult;
 331
 332     // iterate over different ranges
 333     for( sal_Int32 i = 0;
 334          nEndPos < nLength;
 335          nStartPos = ++nEndPos, i++ )
 336     {
 337         // find start point of next range
 338
 339         // ignore leading '$'
 340         if( rXMLString[ nEndPos ] == aDollar)
 341             nEndPos++;
 342
 343         bool bInQuotation = false;
 344         // parse range
 345         while( nEndPos < nLength &&
 346                ( bInQuotation || rXMLString[ nEndPos ] != aSpace ))
 347         {
 348             // skip escaped characters (with backslash)
 349             if( rXMLString[ nEndPos ] == aBackslash )
 350                 ++nEndPos;
 351             // toggle quotation mode when finding single quotes
 352             else if( rXMLString[ nEndPos ] == aQuote )
 353                 bInQuotation = ! bInQuotation;
 354
 355             ++nEndPos;
 356         }
 357
 358         if( ! lcl_getCellRangeAddressFromXMLString(
 359                 rXMLString,
 360                 nStartPos, nEndPos - 1,
 361                 aResult ))
 362         {
 363             // if an error occured, bail out
 364             return CellRange();
 365         }
 366     }
 367
 368     return aResult;
 369 }
 370
 371 OUString getXMLStringFromCellRange( const CellRange & rRange )
 372 {
 373     static const sal_Unicode aSpace( ' ' );
 374     static const sal_Unicode aQuote( '\'' );
 375
 376     ::rtl::OUStringBuffer aBuffer;
 377
 378     if( (rRange.aTableName).getLength())
 379     {
 380         bool bNeedsEscaping = ( rRange.aTableName.indexOf( aQuote ) > -1 );
 381         bool bNeedsQuoting = bNeedsEscaping || ( rRange.aTableName.indexOf( aSpace ) > -1 );
 382
 383         // quote table name if it contains spaces or quotes
 384         if( bNeedsQuoting )
 385         {
 386             // leading quote
 387             aBuffer.append( aQuote );
 388
 389             // escape existing quotes
 390             if( bNeedsEscaping )
 391             {
 392                 const sal_Unicode * pTableNameBeg = rRange.aTableName.getStr();
 393
 394                 // append the quoted string at the buffer
 395                 ::std::for_each( pTableNameBeg,
 396                                  pTableNameBeg + rRange.aTableName.getLength(),
 397                                  lcl_Escape( aBuffer ) );
 398             }
 399             else
 400                 aBuffer.append( rRange.aTableName );
 401
 402             // final quote
 403             aBuffer.append( aQuote );
 404         }
 405         else
 406             aBuffer.append( rRange.aTableName );
 407     }
 408     aBuffer.append( lcl_getXMLStringForCell( rRange.aUpperLeft ));
 409
 410     if( ! rRange.aLowerRight.empty())
 411     {
 412         // we have a range (not a single cell)
 413         aBuffer.append( sal_Unicode( ':' ));
 414         aBuffer.append( lcl_getXMLStringForCell( rRange.aLowerRight ));
 415     }
 416
 417     return aBuffer.makeStringAndClear();
 418 }
 419
 420 } //  namespace XMLRangeHelper
 421 } //  namespace chart