Version 6.1.0.2, tag libreoffice-6.1.0.2
[LibreOffice.git] / sc / inc / rangelst.hxx
blob6a1afadad037e7f56c62874225f8ada1a20fc613
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_SC_INC_RANGELST_HXX
21 #define INCLUDED_SC_INC_RANGELST_HXX
23 #include "global.hxx"
24 #include "address.hxx"
25 #include <ostream>
26 #include <vector>
27 #include <sal/types.h>
29 class ScDocument;
32 class SAL_WARN_UNUSED SC_DLLPUBLIC ScRangeList final : public SvRefBase
34 public:
35 ScRangeList();
36 ScRangeList( const ScRangeList& rList );
37 ScRangeList( const ScRangeList&& rList );
38 ScRangeList( const ScRange& rRange );
39 virtual ~ScRangeList() override;
41 ScRangeList& operator=(const ScRangeList& rList);
42 ScRangeList& operator=(ScRangeList&& rList);
44 ScRefFlags Parse( const OUString&, const ScDocument*,
45 formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_OOO,
46 SCTAB nDefaultTab = 0, sal_Unicode cDelimiter = 0 );
48 void Format( OUString&, ScRefFlags nFlags, ScDocument*,
49 formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_OOO,
50 sal_Unicode cDelimiter = 0, bool bFullAddressNotation = false ) const;
52 void Join( const ScRange&, bool bIsInList = false );
54 bool UpdateReference( UpdateRefMode, const ScDocument*,
55 const ScRange& rWhere,
56 SCCOL nDx,
57 SCROW nDy,
58 SCTAB nDz
61 void InsertRow( SCTAB nTab, SCCOL nColStart, SCCOL nColEnd, SCROW nRowPos, SCSIZE nSize );
62 void InsertCol( SCTAB nTab, SCROW nRowStart, SCROW nRowEnd, SCCOL nColPos, SCSIZE nSize );
64 /** For now this method assumes that nTab1 == nTab2
65 * The algorithm will be much more complicated if nTab1 != nTab2
67 bool DeleteArea( SCCOL nCol1, SCROW nRow1, SCTAB nTab1, SCCOL nCol2,
68 SCROW nRow2, SCTAB nTab2 );
70 const ScRange* Find( const ScAddress& ) const;
71 ScRange* Find( const ScAddress& );
72 bool operator==( const ScRangeList& ) const;
73 bool operator!=( const ScRangeList& r ) const;
74 bool Intersects( const ScRange& ) const;
75 bool In( const ScRange& ) const;
76 size_t GetCellCount() const;
77 ScAddress GetTopLeftCorner() const;
79 ScRangeList GetIntersectedRange(const ScRange& rRange) const;
81 void Remove(size_t nPos);
82 void RemoveAll();
84 ScRange Combine() const;
86 bool empty() const { return maRanges.empty(); }
87 size_t size() const { return maRanges.size(); }
88 ScRange& operator[](size_t idx) { return maRanges[idx]; }
89 const ScRange& operator[](size_t idx) const { return maRanges[idx]; }
90 ScRange& front() { return maRanges.front(); }
91 const ScRange& front() const { return maRanges.front(); }
92 ScRange& back() { return maRanges.back(); }
93 const ScRange& back() const { return maRanges.back(); }
94 void push_back(const ScRange & rRange);
96 void swap( ScRangeList& r );
98 private:
99 ::std::vector<ScRange> maRanges;
100 SCROW mnMaxRowUsed;
101 typedef std::vector<ScRange>::iterator iterator;
102 typedef std::vector<ScRange>::const_iterator const_iterator;
104 typedef tools::SvRef<ScRangeList> ScRangeListRef;
106 // For use in SAL_DEBUG etc. Output format not guaranteed to be stable.
107 template<typename charT, typename traits>
108 inline std::basic_ostream<charT, traits> & operator <<(std::basic_ostream<charT, traits> & stream, const ScRangeList& rRangeList)
110 stream << "(";
111 for (size_t i = 0; i < rRangeList.size(); ++i)
113 if (i > 0)
114 stream << ",";
115 stream << rRangeList[i];
117 stream << ")";
119 return stream;
122 // RangePairList:
123 // aRange[0]: actual range,
124 // aRange[1]: data for that range, e.g. Rows belonging to a ColName
125 class SC_DLLPUBLIC ScRangePairList : public SvRefBase
127 public:
128 virtual ~ScRangePairList() override;
129 ScRangePairList* Clone() const;
130 void Append( const ScRangePair& rRangePair )
132 maPairs.push_back( rRangePair );
134 void Join( const ScRangePair&, bool bIsInList = false );
135 void UpdateReference( UpdateRefMode, const ScDocument*,
136 const ScRange& rWhere,
137 SCCOL nDx, SCROW nDy, SCTAB nDz );
138 void DeleteOnTab( SCTAB nTab );
139 ScRangePair* Find( const ScAddress& );
140 ScRangePair* Find( const ScRange& );
141 std::vector<const ScRangePair*>
142 CreateNameSortedArray( ScDocument* ) const;
144 void Remove(size_t nPos);
145 void Remove(const ScRangePair & rAdr);
147 size_t size() const;
148 ScRangePair& operator[](size_t idx);
149 const ScRangePair& operator[](size_t idx) const;
151 private:
152 ::std::vector< ScRangePair > maPairs;
154 typedef tools::SvRef<ScRangePairList> ScRangePairListRef;
156 extern "C"
157 int ScRangePairList_QsortNameCompare( const void*, const void* );
159 #endif
161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */