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