Line data Source code
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 "xiname.hxx"
21 : #include "rangenam.hxx"
22 : #include "xistream.hxx"
23 : #include "excform.hxx"
24 : #include "excimp8.hxx"
25 : #include "scextopt.hxx"
26 : #include "document.hxx"
27 :
28 : // *** Implementation ***
29 :
30 252 : XclImpName::TokenStrmData::TokenStrmData( XclImpStream& rStrm ) :
31 252 : mrStrm(rStrm), mnStrmPos(0), mnStrmSize(0) {}
32 :
33 318 : XclImpName::XclImpName( XclImpStream& rStrm, sal_uInt16 nXclNameIdx ) :
34 318 : XclImpRoot( rStrm.GetRoot() ),
35 : mpScData( 0 ),
36 : mcBuiltIn( EXC_BUILTIN_UNKNOWN ),
37 : mnScTab( SCTAB_MAX ),
38 : meNameType( RT_NAME ),
39 : mnXclTab( EXC_NAME_GLOBAL ),
40 : mnNameIndex( nXclNameIdx ),
41 : mbVBName( false ),
42 : mbMacro( false ),
43 318 : mpTokensData( NULL )
44 : {
45 318 : ExcelToSc& rFmlaConv = GetOldFmlaConverter();
46 :
47 : // 1) *** read data from stream *** ---------------------------------------
48 :
49 318 : sal_uInt16 nFlags = 0, nFmlaSize = 0, nExtSheet = EXC_NAME_GLOBAL;
50 318 : sal_uInt8 nNameLen = 0, nShortCut;
51 :
52 318 : switch( GetBiff() )
53 : {
54 : case EXC_BIFF2:
55 : {
56 : sal_uInt8 nFlagsBiff2;
57 0 : rStrm >> nFlagsBiff2;
58 0 : rStrm.Ignore( 1 );
59 0 : rStrm >> nShortCut >> nNameLen;
60 0 : nFmlaSize = rStrm.ReaduInt8();
61 0 : ::set_flag( nFlags, EXC_NAME_FUNC, ::get_flag( nFlagsBiff2, EXC_NAME2_FUNC ) );
62 : }
63 0 : break;
64 :
65 : case EXC_BIFF3:
66 : case EXC_BIFF4:
67 : {
68 0 : rStrm >> nFlags >> nShortCut >> nNameLen >> nFmlaSize;
69 : }
70 0 : break;
71 :
72 : case EXC_BIFF5:
73 : case EXC_BIFF8:
74 : {
75 318 : rStrm >> nFlags >> nShortCut >> nNameLen >> nFmlaSize >> nExtSheet >> mnXclTab;
76 318 : rStrm.Ignore( 4 );
77 : }
78 318 : break;
79 :
80 : default: DBG_ERROR_BIFF();
81 : }
82 :
83 318 : if( GetBiff() <= EXC_BIFF5 )
84 2 : maXclName = rStrm.ReadRawByteString( nNameLen );
85 : else
86 316 : maXclName = rStrm.ReadUniString( nNameLen );
87 :
88 : // 2) *** convert sheet index and name *** --------------------------------
89 :
90 : // functions and VBA
91 318 : bool bFunction = ::get_flag( nFlags, EXC_NAME_FUNC );
92 318 : mbVBName = ::get_flag( nFlags, EXC_NAME_VB );
93 318 : mbMacro = ::get_flag( nFlags, EXC_NAME_PROC );
94 :
95 : // get built-in name, or convert characters invalid in Calc
96 318 : bool bBuiltIn = ::get_flag( nFlags, EXC_NAME_BUILTIN );
97 :
98 : // special case for BIFF5 filter range - name appears as plain text without built-in flag
99 318 : if( (GetBiff() == EXC_BIFF5) && (maXclName == XclTools::GetXclBuiltInDefName(EXC_BUILTIN_FILTERDATABASE)) )
100 : {
101 2 : bBuiltIn = true;
102 2 : maXclName = OUString(EXC_BUILTIN_FILTERDATABASE);
103 : }
104 :
105 : // convert Excel name to Calc name
106 318 : if( mbVBName )
107 : {
108 : // VB macro name
109 2 : maScName = maXclName;
110 : }
111 316 : else if( bBuiltIn )
112 : {
113 : // built-in name
114 64 : if( !maXclName.isEmpty() )
115 64 : mcBuiltIn = maXclName[0];
116 64 : if( mcBuiltIn == '?' ) // NUL character is imported as '?'
117 0 : mcBuiltIn = '\0';
118 64 : maScName = XclTools::GetBuiltInDefName( mcBuiltIn );
119 : }
120 : else
121 : {
122 : // any other name
123 252 : maScName = ScfTools::ConvertToScDefinedName( maXclName );
124 : }
125 :
126 : // add index for local names
127 318 : if( mnXclTab != EXC_NAME_GLOBAL )
128 : {
129 72 : sal_uInt16 nUsedTab = (GetBiff() == EXC_BIFF8) ? mnXclTab : nExtSheet;
130 : // TODO: may not work for BIFF5, handle skipped sheets (all BIFF)
131 72 : mnScTab = static_cast< SCTAB >( nUsedTab - 1 );
132 : }
133 :
134 : // 3) *** convert the name definition formula *** -------------------------
135 :
136 318 : rFmlaConv.Reset();
137 318 : const ScTokenArray* pTokArr = 0; // pointer to token array, owned by rFmlaConv
138 :
139 318 : if( ::get_flag( nFlags, EXC_NAME_BIG ) )
140 : {
141 : // special, unsupported name
142 0 : rFmlaConv.GetDummy( pTokArr );
143 : }
144 318 : else if( bBuiltIn )
145 : {
146 64 : SCsTAB const nLocalTab = (mnXclTab == EXC_NAME_GLOBAL) ? SCTAB_MAX : (mnXclTab - 1);
147 :
148 : // --- print ranges or title ranges ---
149 64 : rStrm.PushPosition();
150 64 : switch( mcBuiltIn )
151 : {
152 : case EXC_BUILTIN_PRINTAREA:
153 10 : if( rFmlaConv.Convert( GetPrintAreaBuffer(), rStrm, nFmlaSize, nLocalTab, FT_RangeName ) == ConvOK )
154 10 : meNameType |= RT_PRINTAREA;
155 10 : break;
156 : case EXC_BUILTIN_PRINTTITLES:
157 0 : if( rFmlaConv.Convert( GetTitleAreaBuffer(), rStrm, nFmlaSize, nLocalTab, FT_RangeName ) == ConvOK )
158 0 : meNameType |= RT_COLHEADER | RT_ROWHEADER;
159 0 : break;
160 : }
161 64 : rStrm.PopPosition();
162 :
163 : // --- name formula ---
164 : // JEG : double check this. It is clearly false for normal names
165 : // but some of the builtins (sheettitle?) might be able to handle arrays
166 64 : rFmlaConv.Convert( pTokArr, rStrm, nFmlaSize, false, FT_RangeName );
167 :
168 : // --- auto or advanced filter ---
169 64 : if( (GetBiff() == EXC_BIFF8) && pTokArr && bBuiltIn )
170 : {
171 62 : ScRange aRange;
172 62 : if (pTokArr->IsReference(aRange, ScAddress()))
173 : {
174 56 : switch( mcBuiltIn )
175 : {
176 : case EXC_BUILTIN_FILTERDATABASE:
177 52 : GetFilterManager().Insert( &GetOldRoot(), aRange);
178 52 : break;
179 : case EXC_BUILTIN_CRITERIA:
180 0 : GetFilterManager().AddAdvancedRange( aRange );
181 0 : meNameType |= RT_CRITERIA;
182 0 : break;
183 : case EXC_BUILTIN_EXTRACT:
184 0 : if (pTokArr->IsValidReference(aRange, ScAddress()))
185 0 : GetFilterManager().AddExtractPos( aRange );
186 0 : break;
187 : }
188 : }
189 : }
190 : }
191 254 : else if( nFmlaSize > 0 )
192 : {
193 : // Regular defined name. We need to convert the tokens after all the
194 : // names have been registered (for cross-referenced names).
195 252 : mpTokensData.reset(new TokenStrmData(rStrm));
196 252 : mpTokensData->mnStrmPos = rStrm.GetSvStreamPos();
197 252 : rStrm.StorePosition(mpTokensData->maStrmPos);
198 252 : mpTokensData->mnStrmSize = nFmlaSize;
199 : }
200 :
201 318 : if (pTokArr && !bFunction && !mbVBName)
202 64 : InsertName(pTokArr);
203 318 : }
204 :
205 318 : void XclImpName::ConvertTokens()
206 : {
207 318 : if (!mpTokensData)
208 384 : return;
209 :
210 252 : ExcelToSc& rFmlaConv = GetOldFmlaConverter();
211 252 : rFmlaConv.Reset();
212 252 : const ScTokenArray* pArray = NULL;
213 :
214 252 : XclImpStreamPos aOldPos;
215 252 : XclImpStream& rStrm = mpTokensData->mrStrm;
216 252 : rStrm.StorePosition(aOldPos);
217 252 : rStrm.RestorePosition(mpTokensData->maStrmPos);
218 252 : rFmlaConv.Convert(pArray, rStrm, mpTokensData->mnStrmSize, true, FT_RangeName);
219 252 : rStrm.RestorePosition(aOldPos);
220 :
221 252 : if (pArray)
222 252 : InsertName(pArray);
223 :
224 252 : mpTokensData.reset();
225 : }
226 :
227 316 : void XclImpName::InsertName(const ScTokenArray* pArray)
228 : {
229 : // create the Calc name data
230 316 : ScRangeData* pData = new ScRangeData(GetDocPtr(), maScName, *pArray, ScAddress(), meNameType);
231 316 : pData->GuessPosition(); // calculate base position for relative refs
232 316 : pData->SetIndex( mnNameIndex ); // used as unique identifier in formulas
233 316 : if (mnXclTab == EXC_NAME_GLOBAL)
234 : {
235 244 : if (!GetDoc().GetRangeName()->insert(pData))
236 0 : pData = NULL;
237 : }
238 : else
239 : {
240 72 : ScRangeName* pLocalNames = GetDoc().GetRangeName(mnScTab);
241 72 : if (pLocalNames)
242 : {
243 72 : if (!pLocalNames->insert(pData))
244 0 : pData = NULL;
245 : }
246 :
247 72 : if (GetBiff() == EXC_BIFF8 && pData)
248 : {
249 70 : ScRange aRange;
250 : // discard deleted ranges ( for the moment at least )
251 70 : if ( pData->IsValidReference( aRange ) )
252 : {
253 64 : GetExtDocOptions().GetOrCreateTabSettings( mnXclTab );
254 : }
255 : }
256 : }
257 316 : if (pData)
258 316 : mpScData = pData; // cache for later use
259 316 : }
260 :
261 144 : XclImpNameManager::XclImpNameManager( const XclImpRoot& rRoot ) :
262 144 : XclImpRoot( rRoot )
263 : {
264 144 : }
265 :
266 318 : void XclImpNameManager::ReadName( XclImpStream& rStrm )
267 : {
268 318 : sal_uLong nCount = maNameList.size();
269 318 : if( nCount < 0xFFFF )
270 318 : maNameList.push_back( new XclImpName( rStrm, static_cast< sal_uInt16 >( nCount + 1 ) ) );
271 318 : }
272 :
273 0 : const XclImpName* XclImpNameManager::FindName( const OUString& rXclName, SCTAB nScTab ) const
274 : {
275 0 : const XclImpName* pGlobalName = 0; // a found global name
276 0 : const XclImpName* pLocalName = 0; // a found local name
277 0 : for( XclImpNameList::const_iterator itName = maNameList.begin(); itName != maNameList.end() && !pLocalName; ++itName )
278 : {
279 0 : if( itName->GetXclName() == rXclName )
280 : {
281 0 : if( itName->GetScTab() == nScTab )
282 0 : pLocalName = &(*itName);
283 0 : else if( itName->IsGlobal() )
284 0 : pGlobalName = &(*itName);
285 : }
286 : }
287 0 : return pLocalName ? pLocalName : pGlobalName;
288 : }
289 :
290 386 : const XclImpName* XclImpNameManager::GetName( sal_uInt16 nXclNameIdx ) const
291 : {
292 : OSL_ENSURE( nXclNameIdx > 0, "XclImpNameManager::GetName - index must be >0" );
293 386 : return ( nXclNameIdx <= 0 || nXclNameIdx > maNameList.size() ) ? NULL : &(maNameList.at( nXclNameIdx - 1 ));
294 : }
295 :
296 142 : void XclImpNameManager::ConvertAllTokens()
297 : {
298 142 : XclImpNameList::iterator it = maNameList.begin(), itEnd = maNameList.end();
299 460 : for (; it != itEnd; ++it)
300 318 : it->ConvertTokens();
301 190 : }
302 :
303 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|