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 "reftokenhelper.hxx"
21 : #include "document.hxx"
22 : #include "rangeutl.hxx"
23 : #include "compiler.hxx"
24 : #include "tokenarray.hxx"
25 :
26 : #include "rtl/ustring.hxx"
27 : #include "formula/grammar.hxx"
28 : #include "formula/token.hxx"
29 :
30 : #include <boost/scoped_ptr.hpp>
31 :
32 : using namespace formula;
33 :
34 : using ::std::vector;
35 :
36 0 : void ScRefTokenHelper::compileRangeRepresentation(
37 : vector<ScTokenRef>& rRefTokens, const OUString& rRangeStr, ScDocument* pDoc,
38 : const sal_Unicode cSep, FormulaGrammar::Grammar eGrammar, bool bOnly3DRef)
39 : {
40 0 : const sal_Unicode cQuote = '\'';
41 :
42 : // #i107275# ignore parentheses
43 0 : OUString aRangeStr = rRangeStr;
44 0 : while( (aRangeStr.getLength() >= 2) && (aRangeStr[ 0 ] == '(') && (aRangeStr[ aRangeStr.getLength() - 1 ] == ')') )
45 0 : aRangeStr = aRangeStr.copy( 1, aRangeStr.getLength() - 2 );
46 :
47 0 : bool bFailure = false;
48 0 : sal_Int32 nOffset = 0;
49 0 : while (nOffset >= 0 && !bFailure)
50 : {
51 0 : OUString aToken;
52 0 : ScRangeStringConverter::GetTokenByOffset(aToken, aRangeStr, nOffset, cSep, cQuote);
53 0 : if (nOffset < 0)
54 0 : break;
55 :
56 0 : ScCompiler aCompiler(pDoc, ScAddress(0,0,0));
57 0 : aCompiler.SetGrammar(eGrammar);
58 0 : boost::scoped_ptr<ScTokenArray> pArray(aCompiler.CompileString(aToken));
59 :
60 : // There MUST be exactly one reference per range token and nothing
61 : // else, and it MUST be a valid reference, not some #REF!
62 0 : sal_uInt16 nLen = pArray->GetLen();
63 0 : if (!nLen)
64 0 : continue; // Should a missing range really be allowed?
65 0 : if (nLen != 1)
66 : {
67 0 : bFailure = true;
68 0 : break;
69 : }
70 :
71 0 : pArray->Reset();
72 0 : const FormulaToken* p = pArray->Next();
73 0 : if (!p)
74 : {
75 0 : bFailure = true;
76 0 : break;
77 : }
78 :
79 0 : const ScToken* pT = static_cast<const ScToken*>(p);
80 0 : switch (pT->GetType())
81 : {
82 : case svSingleRef:
83 : {
84 0 : const ScSingleRefData& rRef = pT->GetSingleRef();
85 0 : if (!rRef.Valid())
86 0 : bFailure = true;
87 0 : else if (bOnly3DRef && !rRef.IsFlag3D())
88 0 : bFailure = true;
89 : }
90 0 : break;
91 : case svDoubleRef:
92 : {
93 0 : const ScComplexRefData& rRef = pT->GetDoubleRef();
94 0 : if (!rRef.Valid())
95 0 : bFailure = true;
96 0 : else if (bOnly3DRef && !rRef.Ref1.IsFlag3D())
97 0 : bFailure = true;
98 : }
99 0 : break;
100 : case svExternalSingleRef:
101 0 : if (!pT->GetSingleRef().ValidExternal())
102 0 : bFailure = true;
103 0 : break;
104 : case svExternalDoubleRef:
105 0 : if (!pT->GetDoubleRef().ValidExternal())
106 0 : bFailure = true;
107 0 : break;
108 : case svString:
109 0 : if (pT->GetString().isEmpty())
110 0 : bFailure = true;
111 0 : break;
112 : default:
113 0 : bFailure = true;
114 0 : break;
115 : }
116 0 : if (!bFailure)
117 : rRefTokens.push_back(
118 0 : ScTokenRef(static_cast<ScToken*>(p->Clone())));
119 :
120 0 : }
121 0 : if (bFailure)
122 0 : rRefTokens.clear();
123 0 : }
124 :
125 0 : bool ScRefTokenHelper::getRangeFromToken(
126 : ScRange& rRange, const ScTokenRef& pToken, const ScAddress& rPos, bool bExternal)
127 : {
128 0 : StackVar eType = pToken->GetType();
129 0 : switch (pToken->GetType())
130 : {
131 : case svSingleRef:
132 : case svExternalSingleRef:
133 : {
134 0 : if ((eType == svExternalSingleRef && !bExternal) ||
135 0 : (eType == svSingleRef && bExternal))
136 0 : return false;
137 :
138 0 : const ScSingleRefData& rRefData = pToken->GetSingleRef();
139 0 : rRange.aStart = rRefData.toAbs(rPos);
140 0 : rRange.aEnd = rRange.aStart;
141 0 : return true;
142 : }
143 : case svDoubleRef:
144 : case svExternalDoubleRef:
145 : {
146 0 : if ((eType == svExternalDoubleRef && !bExternal) ||
147 0 : (eType == svDoubleRef && bExternal))
148 0 : return false;
149 :
150 0 : const ScComplexRefData& rRefData = pToken->GetDoubleRef();
151 0 : rRange = rRefData.toAbs(rPos);
152 0 : return true;
153 : }
154 : default:
155 : ; // do nothing
156 : }
157 0 : return false;
158 : }
159 :
160 0 : void ScRefTokenHelper::getRangeListFromTokens(
161 : ScRangeList& rRangeList, const vector<ScTokenRef>& rTokens, const ScAddress& rPos)
162 : {
163 0 : vector<ScTokenRef>::const_iterator itr = rTokens.begin(), itrEnd = rTokens.end();
164 0 : for (; itr != itrEnd; ++itr)
165 : {
166 0 : ScRange aRange;
167 0 : getRangeFromToken(aRange, *itr, rPos);
168 0 : rRangeList.Append(aRange);
169 : }
170 0 : }
171 :
172 0 : void ScRefTokenHelper::getTokenFromRange(ScTokenRef& pToken, const ScRange& rRange)
173 : {
174 : ScComplexRefData aData;
175 0 : aData.InitRange(rRange);
176 0 : aData.Ref1.SetFlag3D(true);
177 :
178 : // Display sheet name on 2nd reference only when the 1st and 2nd refs are on
179 : // different sheets.
180 0 : aData.Ref2.SetFlag3D(rRange.aStart.Tab() != rRange.aEnd.Tab());
181 :
182 0 : pToken.reset(new ScDoubleRefToken(aData));
183 0 : }
184 :
185 0 : void ScRefTokenHelper::getTokensFromRangeList(vector<ScTokenRef>& pTokens, const ScRangeList& rRanges)
186 : {
187 0 : vector<ScTokenRef> aTokens;
188 0 : size_t nCount = rRanges.size();
189 0 : aTokens.reserve(nCount);
190 0 : for (size_t i = 0; i < nCount; ++i)
191 : {
192 0 : const ScRange* pRange = rRanges[i];
193 0 : if (!pRange)
194 : // failed.
195 0 : return;
196 :
197 0 : ScTokenRef pToken;
198 0 : ScRefTokenHelper::getTokenFromRange(pToken,* pRange);
199 0 : aTokens.push_back(pToken);
200 0 : }
201 0 : pTokens.swap(aTokens);
202 : }
203 :
204 0 : bool ScRefTokenHelper::isRef(const ScTokenRef& pToken)
205 : {
206 0 : switch (pToken->GetType())
207 : {
208 : case svSingleRef:
209 : case svDoubleRef:
210 : case svExternalSingleRef:
211 : case svExternalDoubleRef:
212 0 : return true;
213 : default:
214 : ;
215 : }
216 0 : return false;
217 : }
218 :
219 0 : bool ScRefTokenHelper::isExternalRef(const ScTokenRef& pToken)
220 : {
221 0 : switch (pToken->GetType())
222 : {
223 : case svExternalSingleRef:
224 : case svExternalDoubleRef:
225 0 : return true;
226 : default:
227 : ;
228 : }
229 0 : return false;
230 : }
231 :
232 0 : bool ScRefTokenHelper::intersects(
233 : const vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos)
234 : {
235 0 : if (!isRef(pToken))
236 0 : return false;
237 :
238 0 : bool bExternal = isExternalRef(pToken);
239 0 : sal_uInt16 nFileId = bExternal ? pToken->GetIndex() : 0;
240 :
241 0 : ScRange aRange;
242 0 : getRangeFromToken(aRange, pToken, rPos, bExternal);
243 :
244 0 : vector<ScTokenRef>::const_iterator itr = rTokens.begin(), itrEnd = rTokens.end();
245 0 : for (; itr != itrEnd; ++itr)
246 : {
247 0 : const ScTokenRef& p = *itr;
248 0 : if (!isRef(p))
249 0 : continue;
250 :
251 0 : if (bExternal != isExternalRef(p))
252 0 : continue;
253 :
254 0 : ScRange aRange2;
255 0 : getRangeFromToken(aRange2, p, rPos, bExternal);
256 :
257 0 : if (bExternal && nFileId != p->GetIndex())
258 : // different external file
259 0 : continue;
260 :
261 0 : if (aRange.Intersects(aRange2))
262 0 : return true;
263 : }
264 0 : return false;
265 : }
266 :
267 : namespace {
268 :
269 : class JoinRefTokenRanges
270 : {
271 : public:
272 : /**
273 : * Insert a new reference token into the existing list of reference tokens,
274 : * but in that process, try to join as many adjacent ranges as possible.
275 : *
276 : * @param rTokens existing list of reference tokens
277 : * @param rToken new token
278 : */
279 0 : void operator() (vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos)
280 : {
281 0 : join(rTokens, pToken, rPos);
282 0 : }
283 :
284 : private:
285 :
286 : /**
287 : * Check two 1-dimensional ranges to see if they overlap each other.
288 : *
289 : * @param nMin1 min value of range 1
290 : * @param nMax1 max value of range 1
291 : * @param nMin2 min value of range 2
292 : * @param nMax2 max value of range 2
293 : * @param rNewMin min value of new range in case they overlap
294 : * @param rNewMax max value of new range in case they overlap
295 : */
296 : template<typename T>
297 0 : static bool overlaps(T nMin1, T nMax1, T nMin2, T nMax2, T& rNewMin, T& rNewMax)
298 : {
299 0 : bool bDisjoint1 = (nMin1 > nMax2) && (nMin1 - nMax2 > 1);
300 0 : bool bDisjoint2 = (nMin2 > nMax1) && (nMin2 - nMax1 > 1);
301 0 : if (bDisjoint1 || bDisjoint2)
302 : // These two ranges cannot be joined. Move on.
303 0 : return false;
304 :
305 0 : T nMin = nMin1 < nMin2 ? nMin1 : nMin2;
306 0 : T nMax = nMax1 > nMax2 ? nMax1 : nMax2;
307 :
308 0 : rNewMin = nMin;
309 0 : rNewMax = nMax;
310 :
311 0 : return true;
312 : }
313 :
314 0 : void join(vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos)
315 : {
316 : // Normalize the token to a double reference.
317 : ScComplexRefData aData;
318 0 : if (!ScRefTokenHelper::getDoubleRefDataFromToken(aData, pToken))
319 0 : return;
320 :
321 : // Get the information of the new token.
322 0 : bool bExternal = ScRefTokenHelper::isExternalRef(pToken);
323 0 : sal_uInt16 nFileId = bExternal ? pToken->GetIndex() : 0;
324 0 : OUString aTabName = bExternal ? pToken->GetString().getString() : OUString();
325 :
326 0 : bool bJoined = false;
327 0 : vector<ScTokenRef>::iterator itr = rTokens.begin(), itrEnd = rTokens.end();
328 0 : for (; itr != itrEnd; ++itr)
329 : {
330 0 : ScTokenRef& pOldToken = *itr;
331 :
332 0 : if (!ScRefTokenHelper::isRef(pOldToken))
333 : // A non-ref token should not have been added here in the first
334 : // place!
335 0 : continue;
336 :
337 0 : if (bExternal != ScRefTokenHelper::isExternalRef(pOldToken))
338 : // External and internal refs don't mix.
339 0 : continue;
340 :
341 0 : if (bExternal)
342 : {
343 0 : if (nFileId != pOldToken->GetIndex())
344 : // Different external files.
345 0 : continue;
346 :
347 0 : if (aTabName != pOldToken->GetString().getString())
348 : // Different table names.
349 0 : continue;
350 : }
351 :
352 : ScComplexRefData aOldData;
353 0 : if (!ScRefTokenHelper::getDoubleRefDataFromToken(aOldData, pOldToken))
354 0 : continue;
355 :
356 0 : ScRange aOld = aOldData.toAbs(rPos), aNew = aData.toAbs(rPos);
357 :
358 0 : if (aNew.aStart.Tab() != aOld.aStart.Tab() || aNew.aEnd.Tab() != aOld.aEnd.Tab())
359 : // Sheet ranges differ.
360 0 : continue;
361 :
362 0 : if (aOld.In(aNew))
363 : // This new range is part of an existing range. Skip it.
364 0 : return;
365 :
366 0 : bool bSameRows = (aNew.aStart.Row() == aOld.aStart.Row()) && (aNew.aEnd.Row() == aOld.aEnd.Row());
367 0 : bool bSameCols = (aNew.aStart.Col() == aOld.aStart.Col()) && (aNew.aEnd.Col() == aOld.aEnd.Col());
368 0 : ScComplexRefData aNewData = aOldData;
369 0 : bool bJoinRanges = false;
370 0 : if (bSameRows)
371 : {
372 : SCCOL nNewMin, nNewMax;
373 : bJoinRanges = overlaps(
374 0 : aNew.aStart.Col(), aNew.aEnd.Col(), aOld.aStart.Col(), aOld.aEnd.Col(),
375 0 : nNewMin, nNewMax);
376 :
377 0 : if (bJoinRanges)
378 : {
379 0 : aNew.aStart.SetCol(nNewMin);
380 0 : aNew.aEnd.SetCol(nNewMax);
381 0 : aNewData.SetRange(aNew, rPos);
382 : }
383 : }
384 0 : else if (bSameCols)
385 : {
386 : SCROW nNewMin, nNewMax;
387 : bJoinRanges = overlaps(
388 : aNew.aStart.Row(), aNew.aEnd.Row(), aOld.aStart.Row(), aOld.aEnd.Row(),
389 0 : nNewMin, nNewMax);
390 :
391 0 : if (bJoinRanges)
392 : {
393 0 : aNew.aStart.SetRow(nNewMin);
394 0 : aNew.aEnd.SetRow(nNewMax);
395 0 : aNewData.SetRange(aNew, rPos);
396 : }
397 : }
398 :
399 0 : if (bJoinRanges)
400 : {
401 0 : if (bExternal)
402 0 : pOldToken.reset(new ScExternalDoubleRefToken(nFileId, aTabName, aNewData));
403 : else
404 0 : pOldToken.reset(new ScDoubleRefToken(aNewData));
405 :
406 0 : bJoined = true;
407 0 : break;
408 : }
409 : }
410 :
411 0 : if (bJoined)
412 : {
413 0 : if (rTokens.size() == 1)
414 : // There is only one left. No need to do more joining.
415 0 : return;
416 :
417 : // Pop the last token from the list, and keep joining recursively.
418 0 : ScTokenRef p = rTokens.back();
419 0 : rTokens.pop_back();
420 0 : join(rTokens, p, rPos);
421 : }
422 : else
423 0 : rTokens.push_back(pToken);
424 : }
425 : };
426 :
427 : }
428 :
429 0 : void ScRefTokenHelper::join(vector<ScTokenRef>& rTokens, const ScTokenRef& pToken, const ScAddress& rPos)
430 : {
431 : JoinRefTokenRanges join;
432 0 : join(rTokens, pToken, rPos);
433 0 : }
434 :
435 0 : bool ScRefTokenHelper::getDoubleRefDataFromToken(ScComplexRefData& rData, const ScTokenRef& pToken)
436 : {
437 0 : switch (pToken->GetType())
438 : {
439 : case svSingleRef:
440 : case svExternalSingleRef:
441 : {
442 0 : const ScSingleRefData& r = pToken->GetSingleRef();
443 0 : rData.Ref1 = r;
444 0 : rData.Ref1.SetFlag3D(true);
445 0 : rData.Ref2 = r;
446 0 : rData.Ref2.SetFlag3D(false); // Don't display sheet name on second reference.
447 : }
448 0 : break;
449 : case svDoubleRef:
450 : case svExternalDoubleRef:
451 0 : rData = pToken->GetDoubleRef();
452 0 : break;
453 : default:
454 : // Not a reference token. Bail out.
455 0 : return false;
456 : }
457 0 : return true;
458 : }
459 :
460 0 : ScTokenRef ScRefTokenHelper::createRefToken(const ScAddress& rAddr)
461 : {
462 : ScSingleRefData aRefData;
463 0 : aRefData.InitAddress(rAddr);
464 0 : ScTokenRef pRef(new ScSingleRefToken(aRefData));
465 0 : return pRef;
466 : }
467 :
468 0 : ScTokenRef ScRefTokenHelper::createRefToken(const ScRange& rRange)
469 : {
470 : ScComplexRefData aRefData;
471 0 : aRefData.InitRange(rRange);
472 0 : ScTokenRef pRef(new ScDoubleRefToken(aRefData));
473 0 : return pRef;
474 : }
475 :
476 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
