| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #include "oox/xls/commentsbuffer.hxx" |
| |
| #include <com/sun/star/sheet/XSheetAnnotationAnchor.hpp> |
| #include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.hpp> |
| #include <com/sun/star/sheet/XSheetAnnotations.hpp> |
| #include <com/sun/star/sheet/XSheetAnnotationsSupplier.hpp> |
| #include "oox/helper/attributelist.hxx" |
| #include "oox/vml/vmlshape.hxx" |
| #include "oox/xls/addressconverter.hxx" |
| #include "oox/xls/biffinputstream.hxx" |
| #include "oox/xls/drawingfragment.hxx" |
| #include "oox/xls/drawingmanager.hxx" |
| |
| namespace oox { |
| namespace xls { |
| |
| // ============================================================================ |
| |
| using namespace ::com::sun::star::drawing; |
| using namespace ::com::sun::star::sheet; |
| using namespace ::com::sun::star::table; |
| using namespace ::com::sun::star::text; |
| using namespace ::com::sun::star::uno; |
| |
| using ::rtl::OUString; |
| |
| // ============================================================================ |
| |
| namespace { |
| |
| const sal_uInt16 BIFF_NOTE_VISIBLE = 0x0002; |
| |
| } // namespace |
| |
| // ============================================================================ |
| |
| CommentModel::CommentModel() : |
| mnAuthorId( -1 ), |
| mnObjId( BIFF_OBJ_INVALID_ID ), |
| mbVisible( false ) |
| { |
| } |
| |
| // ---------------------------------------------------------------------------- |
| |
| Comment::Comment( const WorksheetHelper& rHelper ) : |
| WorksheetHelper( rHelper ) |
| { |
| } |
| |
| void Comment::importComment( const AttributeList& rAttribs ) |
| { |
| maModel.mnAuthorId = rAttribs.getInteger( XML_authorId, -1 ); |
| // cell range will be checked while inserting the comment into the document |
| getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, rAttribs.getString( XML_ref, OUString() ), getSheetIndex() ); |
| } |
| |
| void Comment::importComment( SequenceInputStream& rStrm ) |
| { |
| BinRange aBinRange; |
| rStrm >> maModel.mnAuthorId >> aBinRange; |
| // cell range will be checked while inserting the comment into the document |
| getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, aBinRange, getSheetIndex() ); |
| } |
| |
| void Comment::importNote( BiffInputStream& rStrm ) |
| { |
| BinAddress aBinAddr; |
| rStrm >> aBinAddr; |
| // cell range will be checked while inserting the comment into the document |
| getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, BinRange( aBinAddr ), getSheetIndex() ); |
| |
| // remaining record data is BIFF dependent |
| switch( getBiff() ) |
| { |
| case BIFF2: |
| case BIFF3: |
| importNoteBiff2( rStrm ); |
| break; |
| case BIFF4: |
| case BIFF5: |
| importNoteBiff2( rStrm ); |
| // in BIFF4 and BIFF5, comments can have an associated sound |
| if( (rStrm.getNextRecId() == BIFF_ID_NOTESOUND) && rStrm.startNextRecord() ) |
| importNoteSound( rStrm ); |
| break; |
| case BIFF8: |
| importNoteBiff8( rStrm ); |
| break; |
| case BIFF_UNKNOWN: |
| break; |
| } |
| } |
| |
| RichStringRef Comment::createText() |
| { |
| maModel.mxText.reset( new RichString( *this ) ); |
| return maModel.mxText; |
| } |
| |
| void Comment::finalizeImport() |
| { |
| // BIFF12 stores cell range instead of cell address, use first cell of this range |
| OSL_ENSURE( (maModel.maRange.StartColumn == maModel.maRange.EndColumn) && |
| (maModel.maRange.StartRow == maModel.maRange.EndRow), |
| "Comment::finalizeImport - comment anchor should be a single cell" ); |
| CellAddress aNotePos( maModel.maRange.Sheet, maModel.maRange.StartColumn, maModel.maRange.StartRow ); |
| if( getAddressConverter().checkCellAddress( aNotePos, true ) && maModel.mxText.get() ) try |
| { |
| Reference< XSheetAnnotationsSupplier > xAnnosSupp( getSheet(), UNO_QUERY_THROW ); |
| Reference< XSheetAnnotations > xAnnos( xAnnosSupp->getAnnotations(), UNO_SET_THROW ); |
| // non-empty string required by note implementation (real text will be added below) |
| xAnnos->insertNew( aNotePos, OUString( sal_Unicode( ' ' ) ) ); |
| |
| // receive created note from cell (insertNew does not return the note) |
| Reference< XSheetAnnotationAnchor > xAnnoAnchor( getCell( aNotePos ), UNO_QUERY_THROW ); |
| Reference< XSheetAnnotation > xAnno( xAnnoAnchor->getAnnotation(), UNO_SET_THROW ); |
| Reference< XSheetAnnotationShapeSupplier > xAnnoShapeSupp( xAnno, UNO_QUERY_THROW ); |
| Reference< XShape > xAnnoShape( xAnnoShapeSupp->getAnnotationShape(), UNO_SET_THROW ); |
| |
| // convert shape formatting and visibility |
| sal_Bool bVisible = sal_True; |
| switch( getFilterType() ) |
| { |
| case FILTER_OOXML: |
| if( const ::oox::vml::ShapeBase* pNoteShape = getVmlDrawing().getNoteShape( aNotePos ) ) |
| { |
| // position and formatting |
| pNoteShape->convertFormatting( xAnnoShape ); |
| // visibility |
| const ::oox::vml::ClientData* pClientData = pNoteShape->getClientData(); |
| bVisible = pClientData && pClientData->mbVisible; |
| } |
| break; |
| case FILTER_BIFF: |
| bVisible = maModel.mbVisible; |
| break; |
| case FILTER_UNKNOWN: |
| break; |
| } |
| xAnno->setIsVisible( bVisible ); |
| |
| // insert text and convert text formatting |
| maModel.mxText->finalizeImport(); |
| Reference< XText > xAnnoText( xAnnoShape, UNO_QUERY_THROW ); |
| maModel.mxText->convert( xAnnoText, true ); |
| } |
| catch( Exception& ) |
| { |
| } |
| } |
| |
| // private -------------------------------------------------------------------- |
| |
| void Comment::importNoteBiff2( BiffInputStream& rStrm ) |
| { |
| sal_uInt16 nTotalLen; |
| rStrm >> nTotalLen; |
| sal_uInt16 nPartLen = ::std::min( nTotalLen, static_cast< sal_uInt16 >( rStrm.getRemaining() ) ); |
| RichStringRef xNoteText = createText(); |
| xNoteText->importCharArray( rStrm, nPartLen, getTextEncoding() ); |
| |
| nTotalLen = nTotalLen - nPartLen; // operator-=() gives compiler warning |
| while( (nTotalLen > 0) && (rStrm.getNextRecId() == BIFF_ID_NOTE) && rStrm.startNextRecord() ) |
| { |
| sal_uInt16 nMarker; |
| rStrm >> nMarker; |
| rStrm.skip( 2 ); |
| rStrm >> nPartLen; |
| OSL_ENSURE( nMarker == 0xFFFF, "Comment::importNoteBiff2 - missing continuation NOTE record" ); |
| if( nMarker == 0xFFFF ) |
| { |
| OSL_ENSURE( nPartLen <= nTotalLen, "Comment::importNoteBiff2 - string too long" ); |
| // call to RichString::importCharArray() appends new text portion |
| xNoteText->importCharArray( rStrm, nPartLen, getTextEncoding() ); |
| nTotalLen = nTotalLen - ::std::min( nTotalLen, nPartLen ); |
| } |
| else |
| { |
| // seems to be a new note, rewind record, so worksheet fragment loop will find it |
| rStrm.rewindRecord(); |
| nTotalLen = 0; |
| } |
| } |
| } |
| |
| void Comment::importNoteBiff8( BiffInputStream& rStrm ) |
| { |
| sal_uInt16 nFlags; |
| rStrm >> nFlags >> maModel.mnObjId; |
| maModel.maAuthor = rStrm.readUniString(); |
| maModel.mbVisible = getFlag( nFlags, BIFF_NOTE_VISIBLE ); |
| } |
| |
| void Comment::importNoteSound( BiffInputStream& /*rStrm*/ ) |
| { |
| } |
| |
| // ============================================================================ |
| |
| CommentsBuffer::CommentsBuffer( const WorksheetHelper& rHelper ) : |
| WorksheetHelper( rHelper ) |
| { |
| } |
| |
| void CommentsBuffer::appendAuthor( const OUString& rAuthor ) |
| { |
| maAuthors.push_back( rAuthor ); |
| } |
| |
| CommentRef CommentsBuffer::createComment() |
| { |
| CommentRef xComment( new Comment( *this ) ); |
| maComments.push_back( xComment ); |
| return xComment; |
| } |
| |
| void CommentsBuffer::finalizeImport() |
| { |
| maComments.forEachMem( &Comment::finalizeImport ); |
| } |
| |
| // ============================================================================ |
| |
| } // namespace xls |
| } // namespace oox |