sc/inc/refdata.hxx

   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 #pragma once
  21
  22 #include "address.hxx"
  23 #include "scdllapi.h"
  24 #include "calcmacros.hxx"
  25
  26 struct ScSheetLimits;
  27
  28 /// Single reference (one address) into the sheet
  29 struct SC_DLLPUBLIC ScSingleRefData
  30 {
  31 private:
  32     SCCOL mnCol;
  33     SCROW mnRow;
  34     SCTAB mnTab;
  35
  36     union
  37     {
  38         sal_uInt8 mnFlagValue;
  39         struct
  40         {
  41             bool bColRel     :1;
  42             bool bColDeleted :1;
  43             bool bRowRel     :1;
  44             bool bRowDeleted :1;
  45             bool bTabRel     :1;
  46             bool bTabDeleted :1;
  47             bool bFlag3D     :1;     ///< 3D-Ref
  48             bool bRelName    :1;     ///< Reference derived from RangeName with relative values
  49         } Flags;
  50     };
  51
  52 public:
  53     /// No default ctor, because used in ScRawToken union, set InitFlags!
  54     void InitFlags() { mnFlagValue = 0; }    ///< all FALSE
  55     /// InitAddress: InitFlags and set address
  56     void InitAddress( const ScAddress& rAdr );
  57     void InitAddress( SCCOL nCol, SCROW nRow, SCTAB nTab );
  58     /// InitAddressRel: InitFlags and set address, everything relative to rPos
  59     void InitAddressRel( const ScDocument& rDoc, const ScAddress& rAdr, const ScAddress& rPos );
  60     /// InitFlags and set address, relative to rPos if rRef says so.
  61     void InitFromRefAddress( const ScDocument& rDoc, const ScRefAddress& rRef, const ScAddress& rPos );
  62     sal_uInt8 FlagValue() const { return mnFlagValue;}
  63
  64     void SetColRel( bool bVal ) { Flags.bColRel = bVal; }
  65     bool IsColRel() const { return Flags.bColRel; }
  66     void SetRowRel( bool bVal ) { Flags.bRowRel = bVal; }
  67     bool IsRowRel() const { return Flags.bRowRel; }
  68     void SetTabRel( bool bVal ) { Flags.bTabRel = bVal; }
  69     bool IsTabRel() const { return Flags.bTabRel; }
  70
  71     void SetAbsCol( SCCOL nVal );
  72     void SetRelCol( SCCOL nVal );
  73     void IncCol( SCCOL nInc );
  74     void SetAbsRow( SCROW nVal );
  75     void SetRelRow( SCROW nVal );
  76     void IncRow( SCROW nInc );
  77     void SetAbsTab( SCTAB nVal );
  78     void SetRelTab( SCTAB nVal );
  79     void IncTab( SCTAB nInc );
  80
  81     void SetColDeleted( bool bVal );
  82     bool IsColDeleted() const { return Flags.bColDeleted;}
  83     void SetRowDeleted( bool bVal );
  84     bool IsRowDeleted() const { return Flags.bRowDeleted;}
  85     void SetTabDeleted( bool bVal );
  86     bool IsTabDeleted() const { return Flags.bTabDeleted;}
  87     bool IsDeleted() const;
  88
  89     void SetFlag3D( bool bVal ) { Flags.bFlag3D = bVal; }
  90     bool IsFlag3D() const { return Flags.bFlag3D; }
  91     void SetRelName( bool bVal ) { Flags.bRelName = bVal; }
  92     bool IsRelName() const { return Flags.bRelName; }
  93
  94     bool Valid(const ScDocument& rDoc) const;
  95     bool ColValid(const ScDocument& rDoc) const;
  96     bool RowValid(const ScDocument& rDoc) const;
  97     bool TabValid() const;
  98     /** In external references nTab is -1 if the external document was not
  99         loaded but the sheet was cached, or >=0 if the external document was
 100         loaded. */
 101     bool ValidExternal(const ScDocument& rDoc) const;
 102
 103     ScAddress toAbs( const ScSheetLimits& rLimits, const ScAddress& rPos ) const;
 104     ScAddress toAbs( const ScDocument& rDoc, const ScAddress& rPos ) const;
 105     void SetAddress( const ScSheetLimits& rLimits, const ScAddress& rAddr, const ScAddress& rPos );
 106     SCROW Row() const;
 107     SCCOL Col() const;
 108     SCTAB Tab() const;
 109
 110     /** Adjust ordering (front-top-left/rear-bottom-right) to a new position. */
 111     static void PutInOrder( ScSingleRefData& rRef1, ScSingleRefData& rRef2, const ScAddress& rPos );
 112
 113     bool operator==( const ScSingleRefData& ) const;
 114     bool operator!=( const ScSingleRefData& ) const;
 115
 116 #if DEBUG_FORMULA_COMPILER
 117     void Dump( int nIndent = 0 ) const;
 118 #endif
 119 };
 120
 121 /// Complex reference (a range) into the sheet
 122 struct ScComplexRefData
 123 {
 124     ScSingleRefData Ref1;
 125     ScSingleRefData Ref2;
 126     bool bTrimToData = false;
 127
 128     void InitFlags()
 129         { Ref1.InitFlags(); Ref2.InitFlags(); }
 130     void InitRange( const ScRange& rRange )
 131         {
 132             Ref1.InitAddress( rRange.aStart );
 133             Ref2.InitAddress( rRange.aEnd );
 134         }
 135     void InitRangeRel( const ScDocument& rDoc, const ScRange& rRange, const ScAddress& rPos )
 136         {
 137             Ref1.InitAddressRel( rDoc, rRange.aStart, rPos );
 138             Ref2.InitAddressRel( rDoc, rRange.aEnd, rPos );
 139         }
 140     void InitRange( SCCOL nCol1, SCROW nRow1, SCTAB nTab1,
 141                             SCCOL nCol2, SCROW nRow2, SCTAB nTab2 )
 142         {
 143             Ref1.InitAddress( nCol1, nRow1, nTab1 );
 144             Ref2.InitAddress( nCol2, nRow2, nTab2 );
 145         }
 146
 147     /// InitFlags and set range, relative to rPos if rRef1 and rRef2 say so.
 148     void InitFromRefAddresses( const ScDocument& rDoc, const ScRefAddress& rRef1, const ScRefAddress& rRef2, const ScAddress& rPos );
 149
 150     bool Valid(const ScDocument& rDoc) const;
 151
 152     /** In external references nTab is -1 for the start tab and -1 for the end
 153         tab if one sheet and the external document was not loaded but sheet was
 154         cached, or >=0 also if more than one sheets. */
 155     bool ValidExternal(const ScDocument& rDoc) const;
 156
 157     /** Whether this references entire columns, A:A */
 158     bool IsEntireCol() const
 159     {
 160         // Both row anchors must be absolute.
 161         return Ref1.Row() == 0 && Ref2.Row() == MAXROW && !Ref1.IsRowRel() && !Ref2.IsRowRel();
 162     }
 163
 164     /** Whether this references entire rows, 1:1 */
 165     bool IsEntireRow() const
 166     {
 167         // Both column anchors must be absolute.
 168         return Ref1.Col() == 0 && Ref2.Col() == MAXCOL && !Ref1.IsColRel() && !Ref2.IsColRel();
 169     }
 170
 171     SC_DLLPUBLIC ScRange toAbs( const ScSheetLimits& rLimits, const ScAddress& rPos ) const;
 172     SC_DLLPUBLIC ScRange toAbs( const ScDocument& rDoc, const ScAddress& rPos ) const;
 173
 174     /** Set a new range, assuming that the ordering of the range matches the
 175         ordering of the reference data flags already set. */
 176     void SetRange( const ScSheetLimits& rLimits, const ScRange& rRange, const ScAddress& rPos );
 177
 178     /** Adjust ordering (front-top-left/rear-bottom-right) to a new position. */
 179     void PutInOrder( const ScAddress& rPos );
 180
 181     bool operator==( const ScComplexRefData& r ) const
 182         { return Ref1 == r.Ref1 && Ref2 == r.Ref2; }
 183     /** Enlarge range if reference passed is not within existing range.
 184         ScAddress position is used to calculate absolute references from
 185         relative references. */
 186     ScComplexRefData& Extend( const ScSheetLimits& rLimits, const ScSingleRefData & rRef, const ScAddress & rPos );
 187     ScComplexRefData& Extend( const ScSheetLimits& rLimits, const ScComplexRefData & rRef, const ScAddress & rPos );
 188
 189     /** Increment or decrement end column unless or until sticky.
 190         @see ScRange::IncEndColSticky()
 191         @return TRUE if changed. */
 192     bool IncEndColSticky( const ScDocument& rDoc, SCCOL nDelta, const ScAddress& rPos );
 193
 194     /** Increment or decrement end row unless or until sticky.
 195         @see ScRange::IncEndRowSticky()
 196         @return TRUE if changed. */
 197     bool IncEndRowSticky( const ScDocument& rDoc, SCROW nDelta, const ScAddress& rPos );
 198
 199     bool IsDeleted() const;
 200
 201     bool IsTrimToData() const { return bTrimToData; }
 202     void SetTrimToData(bool bSet) { bTrimToData = bSet; }
 203
 204 #if DEBUG_FORMULA_COMPILER
 205     void Dump( int nIndent = 0 ) const;
 206 #endif
 207 };
 208
 209 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */