Line data Source code
1 : /*
2 : * DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/mozIStorageValueArray.idl
3 : */
4 :
5 : #ifndef __gen_mozIStorageValueArray_h__
6 : #define __gen_mozIStorageValueArray_h__
7 :
8 :
9 : #ifndef __gen_nsISupports_h__
10 : #include "nsISupports.h"
11 : #endif
12 :
13 : /* For IDL files that don't want to include root IDL files. */
14 : #ifndef NS_NO_VTABLE
15 : #define NS_NO_VTABLE
16 : #endif
17 : #include "mozilla/DebugOnly.h"
18 :
19 : /* starting interface: mozIStorageValueArray */
20 : #define MOZISTORAGEVALUEARRAY_IID_STR "6e6306f4-ffa7-40f5-96ca-36159ce8f431"
21 :
22 : #define MOZISTORAGEVALUEARRAY_IID \
23 : {0x6e6306f4, 0xffa7, 0x40f5, \
24 : { 0x96, 0xca, 0x36, 0x15, 0x9c, 0xe8, 0xf4, 0x31 }}
25 :
26 75 : class mozIStorageValueArray : public nsISupports {
27 : public:
28 :
29 : NS_DECLARE_STATIC_IID_ACCESSOR(MOZISTORAGEVALUEARRAY_IID)
30 :
31 : enum {
32 : VALUE_TYPE_NULL = 0,
33 : VALUE_TYPE_INTEGER = 1,
34 : VALUE_TYPE_FLOAT = 2,
35 : VALUE_TYPE_TEXT = 3,
36 : VALUE_TYPE_BLOB = 4
37 : };
38 :
39 : /* readonly attribute unsigned long numEntries; */
40 : NS_IMETHOD GetNumEntries(uint32_t *aNumEntries) = 0;
41 :
42 : /* long getTypeOfIndex (in unsigned long aIndex); */
43 : NS_IMETHOD GetTypeOfIndex(uint32_t aIndex, int32_t *_retval) = 0;
44 :
45 : /* long getInt32 (in unsigned long aIndex); */
46 : NS_IMETHOD GetInt32(uint32_t aIndex, int32_t *_retval) = 0;
47 :
48 : /* long long getInt64 (in unsigned long aIndex); */
49 : NS_IMETHOD GetInt64(uint32_t aIndex, int64_t *_retval) = 0;
50 :
51 : /* double getDouble (in unsigned long aIndex); */
52 : NS_IMETHOD GetDouble(uint32_t aIndex, double *_retval) = 0;
53 :
54 : /* AUTF8String getUTF8String (in unsigned long aIndex); */
55 : NS_IMETHOD GetUTF8String(uint32_t aIndex, nsACString & _retval) = 0;
56 :
57 : /* AString getString (in unsigned long aIndex); */
58 : NS_IMETHOD GetString(uint32_t aIndex, nsAString & _retval) = 0;
59 :
60 : /* void getBlob (in unsigned long aIndex, out unsigned long aDataSize, [array, size_is (aDataSize)] out octet aData); */
61 : NS_IMETHOD GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData) = 0;
62 :
63 : /* AString getBlobAsString (in unsigned long aIndex); */
64 : NS_IMETHOD GetBlobAsString(uint32_t aIndex, nsAString & _retval) = 0;
65 :
66 : /* AUTF8String getBlobAsUTF8String (in unsigned long aIndex); */
67 : NS_IMETHOD GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval) = 0;
68 :
69 : /* boolean getIsNull (in unsigned long aIndex); */
70 : NS_IMETHOD GetIsNull(uint32_t aIndex, bool *_retval) = 0;
71 :
72 : /* [noscript] void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out string aResult); */
73 : NS_IMETHOD GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult) = 0;
74 :
75 : /* [noscript] void getSharedString (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out wstring aResult); */
76 : NS_IMETHOD GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult) = 0;
77 :
78 : /* [noscript] void getSharedBlob (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out octetPtr aResult); */
79 : NS_IMETHOD GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult) = 0;
80 :
81 : /**
82 : * Getters for native code that return their values as
83 : * the return type, for convenience and sanity.
84 : *
85 : * Not virtual; no vtable bloat.
86 : */
87 3 : inline int32_t AsInt32(uint32_t idx) {
88 3 : int32_t v = 0;
89 6 : mozilla::DebugOnly<nsresult> rv = GetInt32(idx, &v);
90 3 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
91 : "Getting value failed, wrong column index?");
92 6 : return v;
93 : }
94 4 : inline int64_t AsInt64(uint32_t idx) {
95 4 : int64_t v = 0;
96 8 : mozilla::DebugOnly<nsresult> rv = GetInt64(idx, &v);
97 4 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
98 : "Getting value failed, wrong column index?");
99 8 : return v;
100 : }
101 : inline double AsDouble(uint32_t idx) {
102 : double v = 0.0;
103 : mozilla::DebugOnly<nsresult> rv = GetDouble(idx, &v);
104 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
105 : "Getting value failed, wrong column index?");
106 : return v;
107 : }
108 0 : inline const char* AsSharedUTF8String(uint32_t idx, uint32_t *len) {
109 0 : const char *str = nullptr;
110 0 : *len = 0;
111 0 : mozilla::DebugOnly<nsresult> rv = GetSharedUTF8String(idx, len, &str);
112 0 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
113 : "Getting value failed, wrong column index?");
114 0 : return str;
115 : }
116 : inline const char16_t* AsSharedWString(uint32_t idx, uint32_t *len) {
117 : const char16_t *str = nullptr;
118 : *len = 0;
119 : mozilla::DebugOnly<nsresult> rv = GetSharedString(idx, len, &str);
120 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
121 : "Getting value failed, wrong column index?");
122 : return str;
123 : }
124 : inline const uint8_t* AsSharedBlob(uint32_t idx, uint32_t *len) {
125 : const uint8_t *blob = nullptr;
126 : *len = 0;
127 : mozilla::DebugOnly<nsresult> rv = GetSharedBlob(idx, len, &blob);
128 : MOZ_ASSERT(NS_SUCCEEDED(rv) || IsNull(idx),
129 : "Getting value failed, wrong column index?");
130 : return blob;
131 : }
132 0 : inline bool IsNull(uint32_t idx) {
133 0 : bool b = false;
134 0 : mozilla::DebugOnly<nsresult> rv = GetIsNull(idx, &b);
135 0 : MOZ_ASSERT(NS_SUCCEEDED(rv),
136 : "Getting value failed, wrong column index?");
137 0 : return b;
138 : }
139 : };
140 :
141 : NS_DEFINE_STATIC_IID_ACCESSOR(mozIStorageValueArray, MOZISTORAGEVALUEARRAY_IID)
142 :
143 : /* Use this macro when declaring classes that implement this interface. */
144 : #define NS_DECL_MOZISTORAGEVALUEARRAY \
145 : NS_IMETHOD GetNumEntries(uint32_t *aNumEntries) override; \
146 : NS_IMETHOD GetTypeOfIndex(uint32_t aIndex, int32_t *_retval) override; \
147 : NS_IMETHOD GetInt32(uint32_t aIndex, int32_t *_retval) override; \
148 : NS_IMETHOD GetInt64(uint32_t aIndex, int64_t *_retval) override; \
149 : NS_IMETHOD GetDouble(uint32_t aIndex, double *_retval) override; \
150 : NS_IMETHOD GetUTF8String(uint32_t aIndex, nsACString & _retval) override; \
151 : NS_IMETHOD GetString(uint32_t aIndex, nsAString & _retval) override; \
152 : NS_IMETHOD GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData) override; \
153 : NS_IMETHOD GetBlobAsString(uint32_t aIndex, nsAString & _retval) override; \
154 : NS_IMETHOD GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval) override; \
155 : NS_IMETHOD GetIsNull(uint32_t aIndex, bool *_retval) override; \
156 : NS_IMETHOD GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult) override; \
157 : NS_IMETHOD GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult) override; \
158 : NS_IMETHOD GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult) override; \
159 :
160 : /* Use this macro when declaring the members of this interface when the
161 : class doesn't implement the interface. This is useful for forwarding. */
162 : #define NS_DECL_NON_VIRTUAL_MOZISTORAGEVALUEARRAY \
163 : nsresult GetNumEntries(uint32_t *aNumEntries); \
164 : nsresult GetTypeOfIndex(uint32_t aIndex, int32_t *_retval); \
165 : nsresult GetInt32(uint32_t aIndex, int32_t *_retval); \
166 : nsresult GetInt64(uint32_t aIndex, int64_t *_retval); \
167 : nsresult GetDouble(uint32_t aIndex, double *_retval); \
168 : nsresult GetUTF8String(uint32_t aIndex, nsACString & _retval); \
169 : nsresult GetString(uint32_t aIndex, nsAString & _retval); \
170 : nsresult GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData); \
171 : nsresult GetBlobAsString(uint32_t aIndex, nsAString & _retval); \
172 : nsresult GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval); \
173 : nsresult GetIsNull(uint32_t aIndex, bool *_retval); \
174 : nsresult GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult); \
175 : nsresult GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult); \
176 : nsresult GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult); \
177 :
178 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
179 : #define NS_FORWARD_MOZISTORAGEVALUEARRAY(_to) \
180 : NS_IMETHOD GetNumEntries(uint32_t *aNumEntries) override { return _to GetNumEntries(aNumEntries); } \
181 : NS_IMETHOD GetTypeOfIndex(uint32_t aIndex, int32_t *_retval) override { return _to GetTypeOfIndex(aIndex, _retval); } \
182 : NS_IMETHOD GetInt32(uint32_t aIndex, int32_t *_retval) override { return _to GetInt32(aIndex, _retval); } \
183 : NS_IMETHOD GetInt64(uint32_t aIndex, int64_t *_retval) override { return _to GetInt64(aIndex, _retval); } \
184 : NS_IMETHOD GetDouble(uint32_t aIndex, double *_retval) override { return _to GetDouble(aIndex, _retval); } \
185 : NS_IMETHOD GetUTF8String(uint32_t aIndex, nsACString & _retval) override { return _to GetUTF8String(aIndex, _retval); } \
186 : NS_IMETHOD GetString(uint32_t aIndex, nsAString & _retval) override { return _to GetString(aIndex, _retval); } \
187 : NS_IMETHOD GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData) override { return _to GetBlob(aIndex, aDataSize, aData); } \
188 : NS_IMETHOD GetBlobAsString(uint32_t aIndex, nsAString & _retval) override { return _to GetBlobAsString(aIndex, _retval); } \
189 : NS_IMETHOD GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval) override { return _to GetBlobAsUTF8String(aIndex, _retval); } \
190 : NS_IMETHOD GetIsNull(uint32_t aIndex, bool *_retval) override { return _to GetIsNull(aIndex, _retval); } \
191 : NS_IMETHOD GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult) override { return _to GetSharedUTF8String(aIndex, aLength, aResult); } \
192 : NS_IMETHOD GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult) override { return _to GetSharedString(aIndex, aLength, aResult); } \
193 : NS_IMETHOD GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult) override { return _to GetSharedBlob(aIndex, aLength, aResult); } \
194 :
195 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
196 : #define NS_FORWARD_SAFE_MOZISTORAGEVALUEARRAY(_to) \
197 : NS_IMETHOD GetNumEntries(uint32_t *aNumEntries) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNumEntries(aNumEntries); } \
198 : NS_IMETHOD GetTypeOfIndex(uint32_t aIndex, int32_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetTypeOfIndex(aIndex, _retval); } \
199 : NS_IMETHOD GetInt32(uint32_t aIndex, int32_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetInt32(aIndex, _retval); } \
200 : NS_IMETHOD GetInt64(uint32_t aIndex, int64_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetInt64(aIndex, _retval); } \
201 : NS_IMETHOD GetDouble(uint32_t aIndex, double *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDouble(aIndex, _retval); } \
202 : NS_IMETHOD GetUTF8String(uint32_t aIndex, nsACString & _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetUTF8String(aIndex, _retval); } \
203 : NS_IMETHOD GetString(uint32_t aIndex, nsAString & _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetString(aIndex, _retval); } \
204 : NS_IMETHOD GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetBlob(aIndex, aDataSize, aData); } \
205 : NS_IMETHOD GetBlobAsString(uint32_t aIndex, nsAString & _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetBlobAsString(aIndex, _retval); } \
206 : NS_IMETHOD GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetBlobAsUTF8String(aIndex, _retval); } \
207 : NS_IMETHOD GetIsNull(uint32_t aIndex, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsNull(aIndex, _retval); } \
208 : NS_IMETHOD GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSharedUTF8String(aIndex, aLength, aResult); } \
209 : NS_IMETHOD GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSharedString(aIndex, aLength, aResult); } \
210 : NS_IMETHOD GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSharedBlob(aIndex, aLength, aResult); } \
211 :
212 : #if 0
213 : /* Use the code below as a template for the implementation class for this interface. */
214 :
215 : /* Header file */
216 : class _MYCLASS_ : public mozIStorageValueArray
217 : {
218 : public:
219 : NS_DECL_ISUPPORTS
220 : NS_DECL_MOZISTORAGEVALUEARRAY
221 :
222 : _MYCLASS_();
223 :
224 : private:
225 : ~_MYCLASS_();
226 :
227 : protected:
228 : /* additional members */
229 : };
230 :
231 : /* Implementation file */
232 : NS_IMPL_ISUPPORTS(_MYCLASS_, mozIStorageValueArray)
233 :
234 : _MYCLASS_::_MYCLASS_()
235 : {
236 : /* member initializers and constructor code */
237 : }
238 :
239 : _MYCLASS_::~_MYCLASS_()
240 : {
241 : /* destructor code */
242 : }
243 :
244 : /* readonly attribute unsigned long numEntries; */
245 : NS_IMETHODIMP _MYCLASS_::GetNumEntries(uint32_t *aNumEntries)
246 : {
247 : return NS_ERROR_NOT_IMPLEMENTED;
248 : }
249 :
250 : /* long getTypeOfIndex (in unsigned long aIndex); */
251 : NS_IMETHODIMP _MYCLASS_::GetTypeOfIndex(uint32_t aIndex, int32_t *_retval)
252 : {
253 : return NS_ERROR_NOT_IMPLEMENTED;
254 : }
255 :
256 : /* long getInt32 (in unsigned long aIndex); */
257 : NS_IMETHODIMP _MYCLASS_::GetInt32(uint32_t aIndex, int32_t *_retval)
258 : {
259 : return NS_ERROR_NOT_IMPLEMENTED;
260 : }
261 :
262 : /* long long getInt64 (in unsigned long aIndex); */
263 : NS_IMETHODIMP _MYCLASS_::GetInt64(uint32_t aIndex, int64_t *_retval)
264 : {
265 : return NS_ERROR_NOT_IMPLEMENTED;
266 : }
267 :
268 : /* double getDouble (in unsigned long aIndex); */
269 : NS_IMETHODIMP _MYCLASS_::GetDouble(uint32_t aIndex, double *_retval)
270 : {
271 : return NS_ERROR_NOT_IMPLEMENTED;
272 : }
273 :
274 : /* AUTF8String getUTF8String (in unsigned long aIndex); */
275 : NS_IMETHODIMP _MYCLASS_::GetUTF8String(uint32_t aIndex, nsACString & _retval)
276 : {
277 : return NS_ERROR_NOT_IMPLEMENTED;
278 : }
279 :
280 : /* AString getString (in unsigned long aIndex); */
281 : NS_IMETHODIMP _MYCLASS_::GetString(uint32_t aIndex, nsAString & _retval)
282 : {
283 : return NS_ERROR_NOT_IMPLEMENTED;
284 : }
285 :
286 : /* void getBlob (in unsigned long aIndex, out unsigned long aDataSize, [array, size_is (aDataSize)] out octet aData); */
287 : NS_IMETHODIMP _MYCLASS_::GetBlob(uint32_t aIndex, uint32_t *aDataSize, uint8_t **aData)
288 : {
289 : return NS_ERROR_NOT_IMPLEMENTED;
290 : }
291 :
292 : /* AString getBlobAsString (in unsigned long aIndex); */
293 : NS_IMETHODIMP _MYCLASS_::GetBlobAsString(uint32_t aIndex, nsAString & _retval)
294 : {
295 : return NS_ERROR_NOT_IMPLEMENTED;
296 : }
297 :
298 : /* AUTF8String getBlobAsUTF8String (in unsigned long aIndex); */
299 : NS_IMETHODIMP _MYCLASS_::GetBlobAsUTF8String(uint32_t aIndex, nsACString & _retval)
300 : {
301 : return NS_ERROR_NOT_IMPLEMENTED;
302 : }
303 :
304 : /* boolean getIsNull (in unsigned long aIndex); */
305 : NS_IMETHODIMP _MYCLASS_::GetIsNull(uint32_t aIndex, bool *_retval)
306 : {
307 : return NS_ERROR_NOT_IMPLEMENTED;
308 : }
309 :
310 : /* [noscript] void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out string aResult); */
311 : NS_IMETHODIMP _MYCLASS_::GetSharedUTF8String(uint32_t aIndex, uint32_t *aLength, const char * *aResult)
312 : {
313 : return NS_ERROR_NOT_IMPLEMENTED;
314 : }
315 :
316 : /* [noscript] void getSharedString (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out wstring aResult); */
317 : NS_IMETHODIMP _MYCLASS_::GetSharedString(uint32_t aIndex, uint32_t *aLength, const char16_t * *aResult)
318 : {
319 : return NS_ERROR_NOT_IMPLEMENTED;
320 : }
321 :
322 : /* [noscript] void getSharedBlob (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out octetPtr aResult); */
323 : NS_IMETHODIMP _MYCLASS_::GetSharedBlob(uint32_t aIndex, uint32_t *aLength, const uint8_t **aResult)
324 : {
325 : return NS_ERROR_NOT_IMPLEMENTED;
326 : }
327 :
328 : /* End of implementation class template. */
329 : #endif
330 :
331 :
332 : #endif /* __gen_mozIStorageValueArray_h__ */
|
