1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 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 );
}
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
|
