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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_BASIC_SBXDEF_HXX
#define INCLUDED_BASIC_SBXDEF_HXX
#include <vcl/errcode.hxx>
#include <o3tl/typed_flags_set.hxx>
enum class SbxClassType { // SBX-class-IDs (order is important!)
DontCare = 1, // don't care (search, not 0 due to StarBASIC)
Array, // Array of SbxVariables
Value, // simple value
Variable, // Variable (from here there is Broadcaster)
Method, // Method (Function or Sub)
Property, // Property
Object // Object
};
enum SbxDataType {
SbxEMPTY = 0, // * Uninitialized
SbxNULL = 1, // * Contains no valid data
SbxINTEGER = 2, // * Integer (sal_Int16)
SbxLONG = 3, // * Long integer (sal_Int32)
SbxSINGLE = 4, // * Single-precision floating point number (float)
SbxDOUBLE = 5, // * Double-precision floating point number (double)
SbxCURRENCY = 6, // Currency (sal_Int64)
SbxDATE = 7, // * Date (double)
SbxSTRING = 8, // * String (StarView)
SbxOBJECT = 9, // * SbxBase object pointer
SbxERROR = 10, // * Error (sal_uInt16)
SbxBOOL = 11, // * Boolean (0 or -1)
SbxVARIANT = 12, // * Display for variant datatype
SbxDATAOBJECT = 13, // * Common data object w/o ref count
SbxCHAR = 16, // * signed char
SbxBYTE = 17, // * unsigned char
SbxUSHORT = 18, // * unsigned short (sal_uInt16)
SbxULONG = 19, // * unsigned long (sal_uInt32)
SbxINT = 22, // * signed machine-dependent int
SbxUINT = 23, // * unsigned machine-dependent int
SbxVOID = 24, // * no value (= SbxEMPTY)
SbxHRESULT = 25, // HRESULT
SbxPOINTER = 26, // generic pointer
SbxDIMARRAY = 27, // dimensioned array
SbxCARRAY = 28, // C style array
SbxUSERDEF = 29, // user defined
SbxLPSTR = 30, // * null terminated string
SbxLPWSTR = 31, // wide null terminated string
SbxCoreSTRING = 32, // from 1997-4-10 for GetCoreString(), only for converting<
SbxWSTRING = 33, // from 2000-10-4 Reimplemented for backwards compatibility (#78919)
SbxWCHAR = 34, // from 2000-10-4 Reimplemented for backwards compatibility (#78919)
SbxSALINT64 = 35, // for currency internal, signed 64-bit int and UNO hyper
SbxSALUINT64= 36, // for currency internal, unsigned 64-bit int and UNO unsigned hyper
SbxDECIMAL = 37, // for UNO/automation Decimal
SbxVECTOR = 0x1000, // simple counted array
SbxARRAY = 0x2000, // array
SbxBYREF = 0x4000, // access by reference
};
const sal_uInt32 SBX_TYPE_WITH_EVENTS_FLAG = 0x10000;
const sal_uInt32 SBX_TYPE_DIM_AS_NEW_FLAG = 0x20000;
const sal_uInt32 SBX_FIXED_LEN_STRING_FLAG = 0x10000; // same value as above as no conflict possible
const sal_uInt32 SBX_TYPE_VAR_TO_DIM_FLAG = 0x40000;
enum SbxOperator {
// Arithmetical:
SbxEXP, // this ^ var
SbxMUL, // this * var
SbxDIV, // this / var
SbxMOD, // this MOD var (max INT32!)
SbxPLUS, // this + var
SbxMINUS, // this - var
SbxNEG, // -this (var is ignored)
SbxIDIV, // this / var (both operands max. sal_Int32!)
// Boolean operators (max sal_Int32!):
// Boolean operators (TODO deprecate this limit: max INT32!)
SbxAND, // this & var
SbxOR, // this | var
SbxXOR, // this ^ var
SbxEQV, // ~this ^ var
SbxIMP, // ~this | var
SbxNOT, // ~this (var is ignored)
// String concatenation:
SbxCAT, // this & var (VBA: this + var)
// Comparisons:
SbxEQ, // this = var
SbxNE, // this <> var
SbxLT, // this < var
SbxGT, // this > var
SbxLE, // this <= var
SbxGE // this >= var
};
enum class SbxNameType { // Type of the questioned name of a variable
NONE, // plain name
ShortTypes, // Name%(A%,B$)
};
// New error codes per define
#define ERRCODE_SBX_SYNTAX ErrCode(1UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_COMPILER)
#define ERRCODE_SBX_NOTIMP ErrCode(2UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_NOTSUPPORTED)
#define ERRCODE_SBX_OVERFLOW ErrCode(3UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // overflow
#define ERRCODE_SBX_BOUNDS ErrCode(4UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // Invalid array index
#define ERRCODE_SBX_ZERODIV ErrCode(5UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // Division by zero
#define ERRCODE_SBX_CONVERSION ErrCode(6UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // wrong data type
#define ERRCODE_SBX_BAD_PARAMETER ErrCode(7UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // invalid Parameter
#define ERRCODE_SBX_PROC_UNDEFINED ErrCode(8UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Sub or Func not def
#define ERRCODE_SBX_ERROR ErrCode(9UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_UNKNOWN) // generic object error
#define ERRCODE_SBX_NO_OBJECT ErrCode(10UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Object var not object
#define ERRCODE_SBX_CANNOT_LOAD ErrCode(11UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_CREATE) // Object init/load fail
#define ERRCODE_SBX_BAD_INDEX ErrCode(12UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // Invalid object index
#define ERRCODE_SBX_NO_ACTIVE_OBJECT ErrCode(13UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_ACCESS) // Object not active
#define ERRCODE_SBX_BAD_PROP_VALUE ErrCode(14UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Bad property value
#define ERRCODE_SBX_PROP_READONLY ErrCode(15UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_READ) // Property is read only
#define ERRCODE_SBX_PROP_WRITEONLY ErrCode(16UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_WRITE) // Property is write only
#define ERRCODE_SBX_INVALID_OBJECT ErrCode(17UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_ACCESS) // Invalid object reference
#define ERRCODE_SBX_NO_METHOD ErrCode(18UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Property or Method unknown
#define ERRCODE_SBX_INVALID_USAGE_OBJECT ErrCode(19UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_ACCESS) // Invalid object usage
#define ERRCODE_SBX_NO_OLE ErrCode(20UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_ACCESS) // No OLE-Object
#define ERRCODE_SBX_BAD_METHOD ErrCode(21UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Method not supported
#define ERRCODE_SBX_OLE_ERROR ErrCode(22UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // OLE Automation Error
#define ERRCODE_SBX_BAD_ACTION ErrCode(23UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_NOTSUPPORTED) // Action not supported
#define ERRCODE_SBX_NO_NAMED_ARGS ErrCode(24UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // No named arguments
#define ERRCODE_SBX_BAD_LOCALE ErrCode(25UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_NOTSUPPORTED) // Locale not supported
#define ERRCODE_SBX_NAMED_NOT_FOUND ErrCode(26UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Unknown named argument
#define ERRCODE_SBX_NOT_OPTIONAL ErrCode(27UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Argument not optional
#define ERRCODE_SBX_WRONG_ARGS ErrCode(28UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_SBX) // Invalid number of arguments
#define ERRCODE_SBX_NOT_A_COLL ErrCode(29UL | ERRCODE_AREA_SBX | ERRCODE_CLASS_RUNTIME) // Object contains no elements
#define LAST_SBX_ERROR_ID 29UL
// Flag-Bits:
enum class SbxFlagBits {
NONE = 0x0000,
Read = 0x0001, // Read permission
Write = 0x0002, // Write permission
ReadWrite = 0x0003, // Read/Write permission
DontStore = 0x0004, // Don't store object
Modified = 0x0008, // Object was changed
Fixed = 0x0010, // Fixed data type (SbxVariable)
Const = 0x0020, // Definition of const value
Optional = 0x0040, // Parameter is optional
Hidden = 0x0080, // Element is invisible
Invisible = 0x0100, // Element is not found by Find()
ExtSearch = 0x0200, // Object is searched completely
ExtFound = 0x0400, // Variable was found through extended search
GlobalSearch = 0x0800, // Global search via Parents
Reserved = 0x1000, // reserved
Private = 0x1000, // #110004, #112015, cannot conflict with SbxFlagBits::Reserved
NoBroadcast = 0x2000, // No broadcast on Get/Put
Reference = 0x4000, // Parameter is Reference (DLL-call)
NoModify = 0x8000, // SetModified is suppressed
WithEvents = 0x0080, // Same value as unused SbxFlagBits::Hidden
DimAsNew = 0x0800, // Same value as SbxFlagBits::GlobalSearch, cannot conflict as one
// is used for objects, the other for variables only
VarToDim = 0x2000, // Same value as SbxFlagBits::NoBroadcast, cannot conflict as
// used for variables without broadcaster only
};
namespace o3tl
{
template<> struct typed_flags<SbxFlagBits> : is_typed_flags<SbxFlagBits, 0xffff> {};
}
// List of all creators for Load/Store
#define SBXCR_SBX 0x20584253 // SBX(blank)
// List of predefined SBX-IDs. New SBX-IDs must be precisely defined so that
// they are unique within the Stream and appropriate Factory.
#define SBXID_VALUE 0x4E4E // NN: SbxValue
#define SBXID_VARIABLE 0x4156 // VA: SbxVariable
#define SBXID_ARRAY 0x5241 // AR: SbxArray
#define SBXID_DIMARRAY 0x4944 // DI: SbxDimArray
#define SBXID_OBJECT 0x424F // OB: SbxObject
#define SBXID_COLLECTION 0x4F43 // CO: SbxCollection
#define SBXID_FIXCOLLECTION 0x4346 // FC: SbxStdCollection
#define SBXID_METHOD 0x454D // ME: SbxMethod
#define SBXID_PROPERTY 0x5250 // PR: SbxProperty
// StarBASIC restricts the base data type to different intervals.
// These intervals are fixed to create 'portability and independent
// of the implementation. Only type double is greedy and takes
// what it gets.
#define SbxMAXCHAR u'\xFFFF'
#define SbxMINCHAR (0)
#define SbxMAXBYTE ( 255)
#define SbxMAXINT ( 32767)
#define SbxMININT (-32768)
#define SbxMAXUINT ((sal_uInt16) 65535)
#define SbxMAXLNG ( 2147483647)
#define SbxMINLNG ((sal_Int32)(-2147483647-1))
#define SbxMAXULNG ((sal_uInt32) 0xffffffff)
#define SbxMAXSALUINT64 SAL_MAX_UINT64
#define SbxMAXSALINT64 SAL_MAX_INT64
#define SbxMINSALINT64 SAL_MIN_INT64
// Currency stored as SbxSALINT64 == sal_Int64
// value range limits are ~(2^63 - 1)/10000
// fixed precision has 4 digits right of decimal pt
#define CURRENCY_FACTOR (10000)
#define CURRENCY_FACTOR_SQUARE (100000000)
// TODO effective MAX/MINCURR limits:
// true value ( 922337203685477.5807) is too precise for correct comparison to 64bit double
#define SbxMAXCURR ( 922337203685477.5807)
#define SbxMINCURR (-922337203685477.5808)
#define SbxMAXSNG ( 3.402823e+38)
#define SbxMINSNG (-3.402823e+38)
#define SbxMAXSNG2 ( 1.175494351e-38)
#define SbxMINSNG2 (-1.175494351e-38)
// Max valid offset index of a Sbx-Array (due to 64K limit)
#define SBX_MAXINDEX 0x3FF0
#define SBX_MAXINDEX32 SbxMAXLNG
// The numeric values of sal_True and FALSE
enum SbxBOOL { SbxFALSE = 0, SbxTRUE = -1 };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
