* Sync up to trunk HEAD (r62975).
[reactos.git] / dll / win32 / oleaut32 / variant.h
1 /*
2 * Variant Inlines
3 *
4 * Copyright 2003 Jon Griffiths
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 */
20
21 #pragma once
22
23 #include <math.h>
24
25 /* Get just the type from a variant pointer */
26 #define V_TYPE(v) (V_VT((v)) & VT_TYPEMASK)
27
28 /* Flags set in V_VT, other than the actual type value */
29 #define VT_EXTRA_TYPE (VT_VECTOR|VT_ARRAY|VT_BYREF|VT_RESERVED)
30
31 /* Get the extra flags from a variant pointer */
32 #define V_EXTRA_TYPE(v) (V_VT((v)) & VT_EXTRA_TYPE)
33
34 /* Missing in Windows but useful VTBIT_* defines */
35 #define VTBIT_BOOL (1 << VT_BSTR)
36 #define VTBIT_BSTR (1 << VT_BSTR)
37 #define VTBIT_DATE (1 << VT_DATE)
38 #define VTBIT_DISPATCH (1 << VT_DISPATCH)
39 #define VTBIT_EMPTY (1 << VT_EMPTY)
40 #define VTBIT_ERROR (1 << VT_ERROR)
41 #define VTBIT_INT (1 << VT_INT)
42 #define VTBIT_NULL (1 << VT_NULL)
43 #define VTBIT_UINT (1 << VT_UINT)
44 #define VTBIT_UNKNOWN (1 << VT_UNKNOWN)
45 #define VTBIT_VARIANT (1 << VT_VARIANT)
46 #define VTBIT_15 (1 << 15) /* no variant type with this number */
47
48 extern const char * const wine_vtypes[] DECLSPEC_HIDDEN;
49 #define debugstr_vt(v) (((v)&VT_TYPEMASK) <= VT_CLSID ? wine_vtypes[((v)&VT_TYPEMASK)] : \
50 ((v)&VT_TYPEMASK) == VT_BSTR_BLOB ? "VT_BSTR_BLOB": "Invalid")
51 #define debugstr_VT(v) (!(v) ? "(null)" : debugstr_vt(V_TYPE((v))))
52
53 extern const char * const wine_vflags[] DECLSPEC_HIDDEN;
54 #define debugstr_vf(v) (wine_vflags[((v)&VT_EXTRA_TYPE)>>12])
55 #define debugstr_VF(v) (!(v) ? "(null)" : debugstr_vf(V_EXTRA_TYPE(v)))
56
57 /* Size constraints */
58 #define I1_MAX 0x7f
59 #define I1_MIN ((-I1_MAX)-1)
60 #define UI1_MAX 0xff
61 #define UI1_MIN 0
62 #define I2_MAX 0x7fff
63 #define I2_MIN ((-I2_MAX)-1)
64 #define UI2_MAX 0xffff
65 #define UI2_MIN 0
66 #define I4_MAX 0x7fffffff
67 #define I4_MIN ((-I4_MAX)-1)
68 #define UI4_MAX 0xffffffff
69 #define UI4_MIN 0
70 #define I8_MAX (((LONGLONG)I4_MAX << 32) | UI4_MAX)
71 #define I8_MIN ((-I8_MAX)-1)
72 #define UI8_MAX (((ULONGLONG)UI4_MAX << 32) | UI4_MAX)
73 #define UI8_MIN 0
74 #define DATE_MAX 2958465
75 #define DATE_MIN -657434
76 #define R4_MAX 3.402823567797336e38
77 #define R4_MIN 1.40129846432481707e-45
78 #define R8_MAX 1.79769313486231470e+308
79 #define R8_MIN 4.94065645841246544e-324
80
81 /* Value of sign for a positive decimal number */
82 #define DECIMAL_POS 0
83
84 /* Native headers don't change the union ordering for DECIMAL sign/scale (duh).
85 * This means that the signscale member is only useful for setting both members to 0.
86 * SIGNSCALE creates endian-correct values so that we can properly set both at once
87 * to values other than 0.
88 */
89 #ifdef WORDS_BIGENDIAN
90 #define SIGNSCALE(sign,scale) (((scale) << 8) | sign)
91 #else
92 #define SIGNSCALE(sign,scale) (((sign) << 8) | scale)
93 #endif
94
95 /* Macros for getting at a DECIMAL's parts */
96 #define DEC_SIGN(d) ((d)->u.s.sign)
97 #define DEC_SCALE(d) ((d)->u.s.scale)
98 #define DEC_SIGNSCALE(d) ((d)->u.signscale)
99 #define DEC_HI32(d) ((d)->Hi32)
100 #define DEC_MID32(d) ((d)->u1.s1.Mid32)
101 #define DEC_LO32(d) ((d)->u1.s1.Lo32)
102 #define DEC_LO64(d) ((d)->u1.Lo64)
103
104 #define DEC_MAX_SCALE 28 /* Maximum scale for a decimal */
105
106 /* Internal flags for low level conversion functions */
107 #define VAR_BOOLONOFF 0x0400 /* Convert bool to "On"/"Off" */
108 #define VAR_BOOLYESNO 0x0800 /* Convert bool to "Yes"/"No" */
109 #define VAR_NEGATIVE 0x1000 /* Number is negative */
110
111 /* The localised characters that make up a valid number */
112 typedef struct tagVARIANT_NUMBER_CHARS
113 {
114 WCHAR cNegativeSymbol;
115 WCHAR cPositiveSymbol;
116 WCHAR cDecimalPoint;
117 WCHAR cDigitSeparator;
118 WCHAR cCurrencyLocal;
119 WCHAR cCurrencyLocal2;
120 WCHAR cCurrencyDecimalPoint;
121 WCHAR cCurrencyDigitSeparator;
122 } VARIANT_NUMBER_CHARS;
123
124 unsigned int get_type_size(ULONG*, VARTYPE);
125 BOOL VARIANT_GetLocalisedText(LANGID, DWORD, WCHAR *) DECLSPEC_HIDDEN;
126 HRESULT VARIANT_ClearInd(VARIANTARG *) DECLSPEC_HIDDEN;
127 BOOL get_date_format(LCID, DWORD, const SYSTEMTIME *,
128 const WCHAR *, WCHAR *, int) DECLSPEC_HIDDEN;