1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef FORMULA_GRAMMAR_HXX
#define FORMULA_GRAMMAR_HXX
#include "com/sun/star/sheet/FormulaLanguage.hpp"
#include "formula/formuladllapi.h"
#include <tools/debug.hxx>
namespace formula
{
/** Grammars digested by ScCompiler.
*/
class FORMULA_DLLPUBLIC FormulaGrammar
{
public:
enum AddressConvention{
CONV_UNSPECIFIED = -1, /* useful when we want method to chose, must be first */
/* elements must be sequential and changes should be reflected in ScCompiler::pCharTables */
CONV_OOO = 0, /* 'doc'#sheet.A1:sheet2.B2 */
CONV_ODF, /* ['doc'#sheet.A1:sheet2.B2] */
CONV_XL_A1, /* [doc]sheet:sheet2!A1:B2 */
CONV_XL_R1C1, /* [doc]sheet:sheet2!R1C1:R2C2 */
CONV_XL_OOX, /* [#]sheet:sheet2!A1:B2 */
CONV_LOTUS_A1, /* external? 3d? A1.B2 <placeholder/> */
CONV_LAST /* for loops, must always be last */
};
//! CONV_UNSPECIFIED is a negative value!
static const int kConventionOffset = - CONV_UNSPECIFIED + 1;
// Room for 32k hypothetical languages plus EXTERNAL.
static const int kConventionShift = 16;
// Room for 256 reference conventions.
static const int kEnglishBit = (1 << (kConventionShift + 8));
// Mask off all non-language bits.
static const int kFlagMask = ~((~int(0)) << kConventionShift);
/** Values encoding the formula language plus address reference convention
plus English parsing/formatting
*/
//! When adding new values adapt isSupported() below as well.
enum Grammar
{
/// Used only in ScCompiler ctor and in some XML import API context.
GRAM_UNSPECIFIED = -1,
/// ODFF with default ODF A1 bracketed references.
GRAM_ODFF = ::com::sun::star::sheet::FormulaLanguage::ODFF |
((CONV_ODF +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// ODF 1.1 with default ODF A1 bracketed references.
GRAM_PODF = ::com::sun::star::sheet::FormulaLanguage::ODF_11 |
((CONV_ODF +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// English with default A1 reference style.
GRAM_ENGLISH = ::com::sun::star::sheet::FormulaLanguage::ENGLISH |
((CONV_OOO +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// Native with default A1 reference style.
GRAM_NATIVE = ::com::sun::star::sheet::FormulaLanguage::NATIVE |
((CONV_OOO +
kConventionOffset) << kConventionShift),
/// ODFF with reference style as set in UI, may be A1 or R1C1.
GRAM_ODFF_UI = ::com::sun::star::sheet::FormulaLanguage::ODFF |
((CONV_UNSPECIFIED +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// ODFF with A1 reference style, unbracketed.
GRAM_ODFF_A1 = ::com::sun::star::sheet::FormulaLanguage::ODFF |
((CONV_OOO +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// ODF 1.1 with reference style as set in UI, may be A1 or R1C1.
GRAM_PODF_UI = ::com::sun::star::sheet::FormulaLanguage::ODF_11 |
((CONV_UNSPECIFIED +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// ODF 1.1 with A1 reference style, unbracketed.
GRAM_PODF_A1 = ::com::sun::star::sheet::FormulaLanguage::ODF_11 |
((CONV_OOO +
kConventionOffset) << kConventionShift) |
kEnglishBit,
/// Native with reference style as set in UI, may be A1 or R1C1.
GRAM_NATIVE_UI = ::com::sun::star::sheet::FormulaLanguage::NATIVE |
((CONV_UNSPECIFIED +
kConventionOffset) << kConventionShift),
/// Native with ODF A1 bracketed references. Not very useful but supported.
GRAM_NATIVE_ODF = ::com::sun::star::sheet::FormulaLanguage::NATIVE |
((CONV_ODF +
kConventionOffset) << kConventionShift),
/// Native with Excel A1 reference style.
GRAM_NATIVE_XL_A1 = ::com::sun::star::sheet::FormulaLanguage::NATIVE |
((CONV_XL_A1 +
kConventionOffset) << kConventionShift),
/// Native with Excel R1C1 reference style.
GRAM_NATIVE_XL_R1C1 = ::com::sun::star::sheet::FormulaLanguage::NATIVE |
((CONV_XL_R1C1 +
kConventionOffset) << kConventionShift),
/// Central definition of the default grammar to be used.
GRAM_DEFAULT = GRAM_NATIVE_UI,
/// Central definition of the default storage grammar to be used.
GRAM_STORAGE_DEFAULT = GRAM_ODFF,
/** OpCodeMap set by external filter and merged with reference
convention plus English bit on top. Plain value acts as
FormulaLanguage. */
GRAM_EXTERNAL = (1 << (kConventionShift - 1))
};
/// If English parsing/formatting is associated with a grammar.
static inline bool isEnglish( const Grammar eGrammar )
{
return (eGrammar & kEnglishBit) != 0;
}
/** Compatibility helper for old "bCompileEnglish, bCompileXML" API calls
to obtain the new grammar. */
static Grammar mapAPItoGrammar( const bool bEnglish, const bool bXML )
{
Grammar eGrammar;
if (bEnglish && bXML)
eGrammar = GRAM_PODF;
else if (bEnglish && !bXML)
eGrammar = GRAM_PODF_A1;
else if (!bEnglish && bXML)
eGrammar = GRAM_NATIVE_ODF;
else // (!bEnglish && !bXML)
eGrammar = GRAM_NATIVE;
return eGrammar;
}
static bool isSupported( const Grammar eGrammar )
{
switch (eGrammar)
{
case GRAM_ODFF :
case GRAM_PODF :
case GRAM_ENGLISH :
case GRAM_NATIVE :
case GRAM_ODFF_UI :
case GRAM_ODFF_A1 :
case GRAM_PODF_UI :
case GRAM_PODF_A1 :
case GRAM_NATIVE_UI :
case GRAM_NATIVE_ODF :
case GRAM_NATIVE_XL_A1 :
case GRAM_NATIVE_XL_R1C1 :
return true;
default:
return extractFormulaLanguage( eGrammar) == GRAM_EXTERNAL;
}
}
static inline sal_Int32 extractFormulaLanguage( const Grammar eGrammar )
{
return eGrammar & kFlagMask;
}
static inline AddressConvention extractRefConvention( const Grammar eGrammar )
{
return static_cast<AddressConvention>(
((eGrammar & ~kEnglishBit) >> kConventionShift) -
kConventionOffset);
}
static inline Grammar setEnglishBit( const Grammar eGrammar, const bool bEnglish )
{
if (bEnglish)
return static_cast<Grammar>( eGrammar | kEnglishBit);
else
return static_cast<Grammar>( eGrammar & ~kEnglishBit);
}
static inline Grammar mergeToGrammar( const Grammar eGrammar, const AddressConvention eConv )
{
bool bEnglish = isEnglish( eGrammar);
Grammar eGram = static_cast<Grammar>(
extractFormulaLanguage( eGrammar) |
((eConv + kConventionOffset) << kConventionShift));
eGram = setEnglishBit( eGram, bEnglish);
DBG_ASSERT( isSupported( eGram), "CompilerGrammarMap::mergeToGrammar: unsupported grammar");
return eGram;
}
/// If grammar is of ODF 1.1
static inline bool isPODF( const Grammar eGrammar )
{
return extractFormulaLanguage( eGrammar) ==
::com::sun::star::sheet::FormulaLanguage::ODF_11;
}
/// If grammar is of ODFF
static inline bool isODFF( const Grammar eGrammar )
{
return extractFormulaLanguage( eGrammar) ==
::com::sun::star::sheet::FormulaLanguage::ODFF;
}
};
// =============================================================================
} // formula
// =============================================================================
#endif // FORMULA_GRAMMAR_HXX
|
