oox/source/xls/scenariobuffer.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: scenariobuffer.cxx,v $
  10  * $Revision: 1.1 $
  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 #include "oox/xls/scenariobuffer.hxx"
  32 #include <com/sun/star/container/XIndexAccess.hpp>
  33 #include <com/sun/star/sheet/XScenario.hpp>
  34 #include <com/sun/star/sheet/XScenarios.hpp>
  35 #include <com/sun/star/sheet/XScenariosSupplier.hpp>
  36 #include <com/sun/star/sheet/XSpreadsheet.hpp>
  37 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  38 #include "properties.hxx"
  39 #include "oox/helper/attributelist.hxx"
  40 #include "oox/helper/propertyset.hxx"
  41 #include "oox/helper/recordinputstream.hxx"
  42 #include "oox/xls/addressconverter.hxx"
  43 #include "oox/xls/biffinputstream.hxx"
  44
  45 using ::rtl::OUString;
  46 using ::com::sun::star::uno::Exception;
  47 using ::com::sun::star::uno::Reference;
  48 using ::com::sun::star::uno::UNO_QUERY_THROW;
  49 using ::com::sun::star::uno::UNO_SET_THROW;
  50 using ::com::sun::star::container::XIndexAccess;
  51 using ::com::sun::star::container::XNameAccess;
  52 using ::com::sun::star::table::CellAddress;
  53 using ::com::sun::star::table::CellRangeAddress;
  54 using ::com::sun::star::table::XCell;
  55 using ::com::sun::star::sheet::XScenario;
  56 using ::com::sun::star::sheet::XScenarios;
  57 using ::com::sun::star::sheet::XScenariosSupplier;
  58 using ::com::sun::star::sheet::XSpreadsheet;
  59
  60 namespace oox {
  61 namespace xls {
  62
  63 // ============================================================================
  64
  65 namespace {
  66
  67 const sal_Int32 BIFF_SCENARIO_DELETED       = 0x4000;
  68
  69 } // namespace
  70
  71 // ============================================================================
  72
  73 ScenarioCellModel::ScenarioCellModel() :
  74     mnNumFmtId( 0 ),
  75     mbDeleted( false )
  76 {
  77 }
  78
  79 // ----------------------------------------------------------------------------
  80
  81 ScenarioModel::ScenarioModel() :
  82     mbLocked( false ),
  83     mbHidden( false )
  84 {
  85 }
  86
  87 // ----------------------------------------------------------------------------
  88
  89 Scenario::Scenario( const WorkbookHelper& rHelper, sal_Int16 nSheet ) :
  90     WorkbookHelper( rHelper ),
  91     mnSheet( nSheet )
  92 {
  93 }
  94
  95 void Scenario::importScenario( const AttributeList& rAttribs )
  96 {
  97     maModel.maName    = rAttribs.getXString( XML_name, OUString() );
  98     maModel.maComment = rAttribs.getXString( XML_comment, OUString() );
  99     maModel.maUser    = rAttribs.getXString( XML_user, OUString() );
 100     maModel.mbLocked  = rAttribs.getBool( XML_locked, false );
 101     maModel.mbHidden  = rAttribs.getBool( XML_hidden, false );
 102 }
 103
 104 void Scenario::importInputCells( const AttributeList& rAttribs )
 105 {
 106     ScenarioCellModel aModel;
 107     getAddressConverter().convertToCellAddressUnchecked( aModel.maPos, rAttribs.getString( XML_r, OUString() ), mnSheet );
 108     aModel.maValue    = rAttribs.getXString( XML_val, OUString() );
 109     aModel.mnNumFmtId = rAttribs.getInteger( XML_numFmtId, 0 );
 110     aModel.mbDeleted  = rAttribs.getBool( XML_deleted, false );
 111     maCells.push_back( aModel );
 112 }
 113
 114 void Scenario::importScenario( RecordInputStream& rStrm )
 115 {
 116     rStrm.skip( 2 );    // cell count
 117     // two longs instead of flag field
 118     maModel.mbLocked = rStrm.readInt32() != 0;
 119     maModel.mbHidden = rStrm.readInt32() != 0;
 120     rStrm >> maModel.maName >> maModel.maComment >> maModel.maUser;
 121 }
 122
 123 void Scenario::importInputCells( RecordInputStream& rStrm )
 124 {
 125     // TODO: where is the deleted flag?
 126     ScenarioCellModel aModel;
 127     BinAddress aPos;
 128     rStrm >> aPos;
 129     rStrm.skip( 8 );
 130     aModel.mnNumFmtId = rStrm.readuInt16();
 131     rStrm >> aModel.maValue;
 132     getAddressConverter().convertToCellAddressUnchecked( aModel.maPos, aPos, mnSheet );
 133     maCells.push_back( aModel );
 134 }
 135
 136 void Scenario::importScenario( BiffInputStream& rStrm )
 137 {
 138     sal_uInt16 nCellCount;
 139     sal_uInt8 nNameLen, nCommentLen, nUserLen;
 140     rStrm >> nCellCount;
 141     // two bytes instead of flag field
 142     maModel.mbLocked = rStrm.readuInt8() != 0;
 143     maModel.mbHidden = rStrm.readuInt8() != 0;
 144     rStrm >> nNameLen >> nCommentLen >> nUserLen;
 145     maModel.maName = rStrm.readUniStringBody( nNameLen );
 146     // user name: before comment (in difference to leading length field), repeated length
 147     if( nUserLen > 0 )
 148         maModel.maUser = rStrm.readUniString();
 149     // comment: repeated length
 150     if( nCommentLen > 0 )
 151         maModel.maComment = rStrm.readUniString();
 152
 153     // list of cell addresses
 154     for( sal_uInt16 nCell = 0; !rStrm.isEof() && (nCell < nCellCount); ++nCell )
 155     {
 156         ScenarioCellModel aModel;
 157         BinAddress aPos;
 158         rStrm >> aPos;
 159         // deleted flag is encoded in column index
 160         aModel.mbDeleted = getFlag( aPos.mnCol, BIFF_SCENARIO_DELETED );
 161         setFlag( aPos.mnCol, BIFF_SCENARIO_DELETED, false );
 162         getAddressConverter().convertToCellAddressUnchecked( aModel.maPos, aPos, mnSheet );
 163         maCells.push_back( aModel );
 164     }
 165
 166     // list of cell values
 167     for( ScenarioCellVector::iterator aIt = maCells.begin(), aEnd = maCells.end(); !rStrm.isEof() && (aIt != aEnd); ++aIt )
 168         aIt->maValue = rStrm.readUniString();
 169 }
 170
 171 void Scenario::finalizeImport()
 172 {
 173     AddressConverter& rAddrConv = getAddressConverter();
 174     ::std::vector< CellRangeAddress > aRanges;
 175     for( ScenarioCellVector::iterator aIt = maCells.begin(), aEnd = maCells.end(); aIt != aEnd; ++aIt )
 176         if( !aIt->mbDeleted && rAddrConv.checkCellAddress( aIt->maPos, true ) )
 177             aRanges.push_back( CellRangeAddress( aIt->maPos.Sheet, aIt->maPos.Column, aIt->maPos.Row, aIt->maPos.Column, aIt->maPos.Row ) );
 178
 179     if( !aRanges.empty() && (maModel.maName.getLength() > 0) ) try
 180     {
 181         /*  Find an unused name for the scenario (Calc stores scenario data in
 182             hidden sheets named after the scenario following the base sheet). */
 183         Reference< XNameAccess > xSheetsNA( getDocument()->getSheets(), UNO_QUERY_THROW );
 184         OUString aScenName = ContainerHelper::getUnusedName( xSheetsNA, maModel.maName, '_' );
 185
 186         // create the new scenario sheet
 187         Reference< XScenariosSupplier > xScenariosSupp( getSheetFromDoc( mnSheet ), UNO_QUERY_THROW );
 188         Reference< XScenarios > xScenarios( xScenariosSupp->getScenarios(), UNO_SET_THROW );
 189         xScenarios->addNewByName( aScenName, ContainerHelper::vectorToSequence( aRanges ), maModel.maComment );
 190
 191         // write scenario cell values
 192         Reference< XSpreadsheet > xSheet( getSheetFromDoc( aScenName ), UNO_SET_THROW );
 193         for( ScenarioCellVector::iterator aIt = maCells.begin(), aEnd = maCells.end(); aIt != aEnd; ++aIt )
 194         {
 195             if( !aIt->mbDeleted ) try
 196             {
 197                 // use XCell::setFormula to auto-detect values and strings
 198                 Reference< XCell > xCell( xSheet->getCellByPosition( aIt->maPos.Column, aIt->maPos.Row ), UNO_SET_THROW );
 199                 xCell->setFormula( aIt->maValue );
 200             }
 201             catch( Exception& )
 202             {
 203             }
 204         }
 205
 206         // scenario properties
 207         PropertySet aPropSet( xScenarios->getByName( aScenName ) );
 208         aPropSet.setProperty( PROP_IsActive, false );
 209         aPropSet.setProperty( PROP_CopyBack, false );
 210         aPropSet.setProperty( PROP_CopyStyles, false );
 211         aPropSet.setProperty( PROP_CopyFormulas, false );
 212         aPropSet.setProperty( PROP_Protected, maModel.mbLocked );
 213         // #112621# do not show/print scenario border
 214         aPropSet.setProperty( PROP_ShowBorder, false );
 215         aPropSet.setProperty( PROP_PrintBorder, false );
 216     }
 217     catch( Exception& )
 218     {
 219     }
 220 }
 221
 222 // ============================================================================
 223
 224 SheetScenariosModel::SheetScenariosModel() :
 225     mnCurrent( 0 ),
 226     mnShown( 0 )
 227 {
 228 }
 229
 230 // ----------------------------------------------------------------------------
 231
 232 SheetScenarios::SheetScenarios( const WorkbookHelper& rHelper, sal_Int16 nSheet ) :
 233     WorkbookHelper( rHelper ),
 234     mnSheet( nSheet )
 235 {
 236 }
 237
 238 void SheetScenarios::importScenarios( const AttributeList& rAttribs )
 239 {
 240     maModel.mnCurrent = rAttribs.getInteger( XML_current, 0 );
 241     maModel.mnShown   = rAttribs.getInteger( XML_show, 0 );
 242 }
 243
 244 void SheetScenarios::importScenarios( RecordInputStream& rStrm )
 245 {
 246     maModel.mnCurrent = rStrm.readuInt16();
 247     maModel.mnShown   = rStrm.readuInt16();
 248 }
 249
 250 void SheetScenarios::importScenarios( BiffInputStream& rStrm )
 251 {
 252     rStrm.skip( 2 );    // scenario count
 253     maModel.mnCurrent = rStrm.readuInt16();
 254     maModel.mnShown   = rStrm.readuInt16();
 255
 256     // read following SCENARIO records
 257     while( (rStrm.getNextRecId() == BIFF_ID_SCENARIO) && rStrm.startNextRecord() )
 258         createScenario().importScenario( rStrm );
 259 }
 260
 261 Scenario& SheetScenarios::createScenario()
 262 {
 263     ScenarioVector::value_type xScenario( new Scenario( *this, mnSheet ) );
 264     maScenarios.push_back( xScenario );
 265     return *xScenario;
 266 }
 267
 268 void SheetScenarios::finalizeImport()
 269 {
 270     maScenarios.forEachMem( &Scenario::finalizeImport );
 271
 272     // activate a scenario
 273     try
 274     {
 275         Reference< XScenariosSupplier > xScenariosSupp( getSheetFromDoc( mnSheet ), UNO_QUERY_THROW );
 276         Reference< XIndexAccess > xScenariosIA( xScenariosSupp->getScenarios(), UNO_QUERY_THROW );
 277         Reference< XScenario > xScenario( xScenariosIA->getByIndex( maModel.mnShown ), UNO_QUERY_THROW );
 278         xScenario->apply();
 279     }
 280     catch( Exception& )
 281     {
 282     }
 283 }
 284
 285 // ============================================================================
 286
 287 ScenarioBuffer::ScenarioBuffer( const WorkbookHelper& rHelper ) :
 288     WorkbookHelper( rHelper )
 289 {
 290 }
 291
 292 SheetScenarios& ScenarioBuffer::createSheetScenarios( sal_Int16 nSheet )
 293 {
 294     SheetScenariosMap::mapped_type& rxSheetScens = maSheetScenarios[ nSheet ];
 295     if( !rxSheetScens )
 296         rxSheetScens.reset( new SheetScenarios( *this, nSheet ) );
 297     return *rxSheetScens;
 298 }
 299
 300 void ScenarioBuffer::finalizeImport()
 301 {
 302     maSheetScenarios.forEachMem( &SheetScenarios::finalizeImport );
 303 }
 304
 305 // ============================================================================
 306
 307 } // namespace xls
 308 } // namespace oox
 309