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