sc/inc/types.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 #ifndef INCLUDED_SC_INC_TYPES_HXX
  11 #define INCLUDED_SC_INC_TYPES_HXX
  12
  13 #include <sal/types.h>
  14
  15 #include <boost/intrusive_ptr.hpp>
  16 #include <o3tl/typed_flags_set.hxx>
  17
  18 class ScMatrix;
  19
  20 // The typedefs
  21 typedef sal_Int32 SCROW;
  22 typedef sal_Int16 SCCOL;
  23 typedef sal_Int16 SCTAB;
  24 typedef sal_Int32 SCCOLROW;     ///< a type capable of holding either SCCOL or SCROW
  25
  26 typedef ::boost::intrusive_ptr<ScMatrix>        ScMatrixRef;
  27 typedef ::boost::intrusive_ptr<const ScMatrix>  ScConstMatrixRef;
  28
  29 namespace formula { class FormulaToken; }
  30 typedef ::boost::intrusive_ptr<formula::FormulaToken> ScTokenRef;
  31
  32 enum class ScMatValType : sal_uInt8 {
  33     Value        = 0x00,
  34     Boolean      = 0x01,
  35     String       = 0x02,
  36     Empty        = String | 0x04, // STRING plus flag
  37     EmptyPath    = Empty | 0x08,  // EMPTY plus flag
  38     NonvalueMask = EmptyPath      // mask of all non-value bits
  39 };
  40 namespace o3tl{
  41     template<> struct typed_flags<ScMatValType> : o3tl::is_typed_flags<ScMatValType, 0x0f> {};
  42 }
  43
  44 struct ScFormulaCellGroup;
  45 typedef ::boost::intrusive_ptr<ScFormulaCellGroup> ScFormulaCellGroupRef;
  46
  47 /**
  48  * When vectorization is enabled, we could potentially mass-calculate a
  49  * series of formula token arrays in adjacent formula cells in one step,
  50  * provided that they all contain identical set of tokens.
  51  */
  52 enum ScFormulaVectorState
  53 {
  54     FormulaVectorDisabled,
  55     FormulaVectorDisabledNotInSubSet,
  56     FormulaVectorDisabledNotInSoftwareSubset,
  57     FormulaVectorDisabledByOpCode,
  58     FormulaVectorDisabledByStackVariable,
  59
  60     FormulaVectorEnabled,
  61     FormulaVectorCheckReference,
  62     FormulaVectorUnknown
  63 };
  64
  65 namespace sc {
  66
  67 enum class MatrixEdge{
  68     Nothing = 0,
  69     Inside  = 1,
  70     Bottom  = 2,
  71     Left    = 4,
  72     Top     = 8,
  73     Right   = 16,
  74     Open    = 32
  75 }; // typed_flags, template outside of sc namespace
  76
  77 enum GroupCalcState
  78 {
  79     GroupCalcDisabled = 0,
  80     GroupCalcEnabled,
  81     GroupCalcRunning,
  82 };
  83
  84 struct RangeMatrix
  85 {
  86     ScMatrixRef mpMat;
  87     sal_Int32 mnCol1;
  88     sal_Int32 mnRow1;
  89     sal_Int32 mnTab1;
  90     sal_Int32 mnCol2;
  91     sal_Int32 mnRow2;
  92     sal_Int32 mnTab2;
  93
  94     RangeMatrix();
  95
  96     bool isRangeValid() const;
  97 };
  98
  99 struct MultiDataCellState
 100 {
 101     enum StateType { Invalid = 0, Empty, HasOneCell, HasMultipleCells };
 102
 103     StateType meState;
 104
 105     SCCOL mnCol1; //< first non-empty column
 106     SCROW mnRow1; //< first non-empty row
 107
 108     MultiDataCellState();
 109     MultiDataCellState( StateType eState );
 110 };
 111
 112 enum AreaOverlapType
 113 {
 114     AreaInside,
 115     AreaPartialOverlap,
 116     AreaInsideOrOverlap,
 117     OneRowInsideArea,
 118     OneColumnInsideArea
 119 };
 120
 121 enum class ListenerGroupType
 122 {
 123     Single,
 124     Group,
 125     Both
 126 };
 127
 128 enum StartListeningType
 129 {
 130     ConvertToGroupListening,
 131     SingleCellListening,
 132     NoListening
 133 };
 134
 135 }
 136
 137 namespace o3tl{
 138     template<> struct typed_flags<sc::MatrixEdge> : o3tl::is_typed_flags<sc::MatrixEdge, 63> {};
 139 }
 140
 141 #endif
 142
 143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */