sc/inc/cellvalue.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
  10 #pragma once
  11
  12 #include "global.hxx"
  13 #include <svl/sharedstring.hxx>
  14 #include <variant>
  15
  16 class ScDocument;
  17 class ScFormulaCell;
  18 class EditTextObject;
  19 class ScColumn;
  20 struct ScRefCellValue;
  21
  22 namespace sc {
  23 struct ColumnBlockPosition;
  24 }
  25
  26 /**
  27  * Store arbitrary cell value of any kind.  It only stores cell value and
  28  * nothing else.  It creates a copy of the original cell value, and manages
  29  * the life cycle of the copied value.
  30  */
  31 struct ScCellValue
  32 {
  33 private:
  34     /// std::monostate is there to indicate CellType::NONE
  35     std::variant<std::monostate, double, svl::SharedString, EditTextObject*, ScFormulaCell*> maData;
  36
  37     void reset_to_empty();
  38 public:
  39
  40     SC_DLLPUBLIC ScCellValue();
  41     ScCellValue( const ScRefCellValue& rCell );
  42     ScCellValue( double fValue );
  43     ScCellValue( const svl::SharedString& rString );
  44     ScCellValue( std::unique_ptr<EditTextObject> );
  45     ScCellValue( const ScCellValue& r );
  46     ScCellValue(ScCellValue&& r) noexcept;
  47     SC_DLLPUBLIC ~ScCellValue();
  48
  49     SC_DLLPUBLIC void clear() noexcept;
  50
  51     SC_DLLPUBLIC void set( double fValue );
  52     SC_DLLPUBLIC void set( const svl::SharedString& rStr );
  53     void set( const EditTextObject& rEditText );
  54     SC_DLLPUBLIC void set( std::unique_ptr<EditTextObject> );
  55     SC_DLLPUBLIC void set( ScFormulaCell* pFormula );
  56
  57     SC_DLLPUBLIC CellType getType() const;
  58     double getDouble() const { return std::get<double>(maData); }
  59     ScFormulaCell* getFormula() const { return std::get<ScFormulaCell*>(maData); }
  60     const svl::SharedString* getSharedString() const { return &std::get<svl::SharedString>(maData); }
  61     EditTextObject* getEditText() const { return std::get<EditTextObject*>(maData); }
  62     EditTextObject* releaseEditText() { auto p = getEditText(); maData = static_cast<EditTextObject*>(nullptr); return p; }
  63     ScFormulaCell* releaseFormula() { auto p = getFormula(); maData = static_cast<ScFormulaCell*>(nullptr); return p; }
  64
  65     /**
  66      * Take cell value from specified position in specified document.
  67      */
  68     void assign( const ScDocument& rDoc, const ScAddress& rPos );
  69
  70     void assign(const ScCellValue& rOther, ScDocument& rDestDoc, ScCloneFlags nCloneFlags = ScCloneFlags::Default);
  71
  72     /**
  73      * Set cell value at specified position in specified document.
  74      */
  75     void commit( ScDocument& rDoc, const ScAddress& rPos ) const;
  76
  77     void commit( ScColumn& rColumn, SCROW nRow ) const;
  78
  79     /**
  80      * Set cell value at specified position in specified document. But unlike
  81      * commit(), this method sets the original value to the document without
  82      * copying.  After this call, the value gets cleared.
  83      */
  84     void release( ScDocument& rDoc, const ScAddress& rPos );
  85
  86     void release( ScColumn& rColumn, SCROW nRow, sc::StartListeningType eListenType = sc::SingleCellListening );
  87
  88     OUString getString( const ScDocument& rDoc ) const;
  89
  90     SC_DLLPUBLIC bool isEmpty() const;
  91
  92     bool equalsWithoutFormat( const ScCellValue& r ) const;
  93
  94     ScCellValue& operator= ( const ScCellValue& r );
  95     ScCellValue& operator=(ScCellValue&& r) noexcept;
  96     ScCellValue& operator= ( const ScRefCellValue& r );
  97
  98     void swap( ScCellValue& r );
  99 };
 100
 101 /**
 102  * This is very similar to ScCellValue, except that it references the
 103  * original value instead of copying it.  As such, don't hold an instance of
 104  * this class any longer than necessary, and absolutely not after the
 105  * original cell has been destroyed.
 106  */
 107 struct SAL_DLLPUBLIC_RTTI ScRefCellValue
 108 {
 109 private:
 110     CellType meType;
 111     union {
 112         double mfValue;
 113         const svl::SharedString* mpString;
 114         const EditTextObject* mpEditText;
 115         ScFormulaCell* mpFormula;
 116     };
 117 public:
 118
 119     SC_DLLPUBLIC ScRefCellValue();
 120     SC_DLLPUBLIC ScRefCellValue( double fValue );
 121     ScRefCellValue( const svl::SharedString* pString );
 122     ScRefCellValue( const EditTextObject* pEditText );
 123     ScRefCellValue( ScFormulaCell* pFormula );
 124
 125     /**
 126      * Take cell value from specified position in specified document.
 127      */
 128     SC_DLLPUBLIC ScRefCellValue( ScDocument& rDoc, const ScAddress& rPos );
 129     SC_DLLPUBLIC ScRefCellValue( ScDocument& rDoc, const ScAddress& rPos, sc::ColumnBlockPosition& rBlockPos );
 130
 131     void clear();
 132
 133     CellType getType() const { return meType; }
 134     double getDouble() const { assert(meType == CELLTYPE_VALUE); return mfValue; }
 135     const svl::SharedString* getSharedString() const { assert(meType == CELLTYPE_STRING); return mpString; }
 136     const EditTextObject* getEditText() const { assert(meType == CELLTYPE_EDIT); return mpEditText; }
 137     ScFormulaCell* getFormula() const { assert(meType == CELLTYPE_FORMULA); return mpFormula; }
 138
 139     /**
 140      * Take cell value from specified position in specified document.
 141      */
 142     SC_DLLPUBLIC void assign( ScDocument& rDoc, const ScAddress& rPos );
 143     void assign( ScDocument& rDoc, const ScAddress& rPos, sc::ColumnBlockPosition& rBlockPos );
 144
 145     /**
 146      * Set cell value at specified position in specified document.
 147      */
 148     void commit( ScDocument& rDoc, const ScAddress& rPos ) const;
 149
 150     bool hasString() const;
 151
 152     SC_DLLPUBLIC bool hasNumeric() const;
 153
 154     bool hasError() const;
 155
 156     double getValue();
 157
 158     /**
 159      * Retrieve a numeric value without modifying the states of any objects in
 160      * the referenced document store.
 161      */
 162     double getRawValue() const;
 163
 164     /**
 165      *  Retrieve string value.
 166      *
 167      *  Note that this method is NOT thread-safe.
 168      *
 169      *  @param  pDoc
 170      *          Needed to resolve EditCells' field contents, obtain a
 171      *          ScFieldEditEngine from that document. May be NULL if there is
 172      *          no ScDocument in the calling context but then the document
 173      *          specific fields can not be resolved. See
 174      *          ScEditUtil::GetString().
 175      */
 176     SC_DLLPUBLIC OUString getString( const ScDocument* pDoc ) const;
 177
 178     /**
 179      * Retrieve a string value without modifying the states of any objects in
 180      * the referenced document store.
 181      *
 182      * This method is thread-safe.
 183      */
 184     OUString getRawString( const ScDocument& rDoc ) const;
 185
 186     SC_DLLPUBLIC bool isEmpty() const;
 187
 188     bool hasEmptyValue();
 189
 190     bool equalsWithoutFormat( const ScRefCellValue& r ) const;
 191 };
 192
 193 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */