Avoid potential negative array index access to cached text.
[LibreOffice.git] / sc / inc / markmulti.hxx
blob9861342dc49b5778e1fbfb9d891cdf260c1c65b5
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 #pragma once
22 #include "segmenttree.hxx"
23 #include "markarr.hxx"
25 #include <vector>
27 class ScRangeList;
28 struct ScSheetLimits;
30 class SC_DLLPUBLIC ScMultiSel
33 private:
34 std::vector<ScMarkArray> aMultiSelContainer;
35 ScMarkArray aRowSel;
36 const ScSheetLimits& mrSheetLimits;
38 friend class ScMultiSelIter;
40 public:
41 ScMultiSel(ScSheetLimits const &);
42 ScMultiSel(const ScMultiSel& rMultiSel) = default;
43 ScMultiSel(ScMultiSel&& rMultiSel) = default;
45 ScMultiSel& operator=(const ScMultiSel& rMultiSel);
46 ScMultiSel& operator=(ScMultiSel&& rMultiSel);
48 SCCOL GetMultiSelectionCount() const;
49 bool HasMarks( SCCOL nCol ) const;
50 bool HasOneMark( SCCOL nCol, SCROW& rStartRow, SCROW& rEndRow ) const;
51 bool GetMark( SCCOL nCol, SCROW nRow ) const;
52 bool IsAllMarked( SCCOL nCol, SCROW nStartRow, SCROW nEndRow ) const;
53 bool HasEqualRowsMarked( SCCOL nCol1, SCCOL nCol2 ) const;
54 SCROW GetNextMarked( SCCOL nCol, SCROW nRow, bool bUp ) const;
55 // Returns the first column of the range [column,nLastCol] for which
56 // all those columns have equal marks. Value returned is not less than nMinCol.
57 SCCOL GetStartOfEqualColumns( SCCOL nLastCol, SCCOL nMinCol = 0 ) const;
58 void SetMarkArea( SCCOL nStartCol, SCCOL nEndCol, SCROW nStartRow, SCROW nEndRow, bool bMark );
59 void Set( ScRangeList const & );
60 bool IsRowMarked( SCROW nRow ) const;
61 bool IsRowRangeMarked( SCROW nStartRow, SCROW nEndRow ) const;
62 bool IsEmpty() const { return ( aMultiSelContainer.empty() && !aRowSel.HasMarks() ); }
63 ScMarkArray GetMarkArray( SCCOL nCol ) const;
64 void Clear();
65 void MarkAllCols( SCROW nStartRow, SCROW nEndRow );
66 bool HasAnyMarks() const;
67 void ShiftCols(SCCOL nStartCol, sal_Int32 nColOffset);
68 void ShiftRows(SCROW nStartRow, sal_Int32 nRowOffset);
70 // For faster access from within ScMarkData, instead of creating
71 // ScMultiSelIter with ScFlatBoolRowSegments bottleneck.
72 const ScMarkArray& GetRowSelArray() const { return aRowSel; }
73 const ScMarkArray* GetMultiSelArray( SCCOL nCol ) const;
76 class ScMultiSelIter
79 private:
80 std::unique_ptr<ScFlatBoolRowSegments> pRowSegs;
81 ScMarkArrayIter aMarkArrayIter;
82 SCROW nNextSegmentStart;
83 public:
84 ScMultiSelIter( const ScMultiSel& rMultiSel, SCCOL nCol );
86 bool Next( SCROW& rTop, SCROW& rBottom );
87 /** Only to be used by ScMultiSel::IsAllMarked() or otherwise sure that a
88 segment tree is actually used. */
89 bool GetRangeData( SCROW nRow, ScFlatBoolRowSegments::RangeData& rRowRange ) const;
92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */