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