dlls/jscript/enumerator.c

   1 /*
   2  * Copyright 2019 Andreas Maier
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #include <assert.h>
  20
  21 #include "jscript.h"
  22
  23 #include "wine/debug.h"
  24
  25 WINE_DEFAULT_DEBUG_CHANNEL(jscript);
  26
  27 typedef struct {
  28     jsdisp_t dispex;
  29     /* IEnumVARIANT returned by _NewEnum */
  30     IEnumVARIANT *enumvar;
  31     /* current item */
  32     jsval_t item;
  33     BOOL atend;
  34 } EnumeratorInstance;
  35
  36 static inline EnumeratorInstance *enumerator_from_jsdisp(jsdisp_t *jsdisp)
  37 {
  38     return CONTAINING_RECORD(jsdisp, EnumeratorInstance, dispex);
  39 }
  40
  41 static inline EnumeratorInstance *enumerator_from_vdisp(vdisp_t *vdisp)
  42 {
  43     return enumerator_from_jsdisp(vdisp->u.jsdisp);
  44 }
  45
  46 static inline EnumeratorInstance *enumerator_this(vdisp_t *jsthis)
  47 {
  48     return is_vclass(jsthis, JSCLASS_ENUMERATOR) ? enumerator_from_vdisp(jsthis) : NULL;
  49 }
  50
  51 static inline HRESULT enumvar_get_next_item(EnumeratorInstance *This)
  52 {
  53     HRESULT hres;
  54     VARIANT nextitem;
  55
  56     if (This->atend)
  57         return S_OK;
  58
  59     /* don't leak previous value */
  60     jsval_release(This->item);
  61
  62     /* not at end ... get next item */
  63     VariantInit(&nextitem);
  64     hres = IEnumVARIANT_Next(This->enumvar, 1, &nextitem, NULL);
  65     if (hres == S_OK)
  66     {
  67         hres = variant_to_jsval(&nextitem, &This->item);
  68         VariantClear(&nextitem);
  69         if (FAILED(hres))
  70         {
  71             WARN("failed to convert jsval to variant!\n");
  72             This->item = jsval_undefined();
  73             return hres;
  74         }
  75     }
  76     else
  77     {
  78         This->item = jsval_undefined();
  79         This->atend = TRUE;
  80     }
  81
  82     return S_OK;
  83 }
  84
  85 static void Enumerator_destructor(jsdisp_t *dispex)
  86 {
  87     EnumeratorInstance *This = enumerator_from_jsdisp(dispex);
  88
  89     TRACE("\n");
  90
  91     jsval_release(This->item);
  92     heap_free(dispex);
  93 }
  94
  95 static HRESULT Enumerator_atEnd(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
  96         jsval_t *r)
  97 {
  98     EnumeratorInstance *This;
  99
 100     if (!(This = enumerator_this(jsthis)))
 101         return JS_E_ENUMERATOR_EXPECTED;
 102
 103     TRACE("%d\n", This->atend);
 104
 105     if (r)
 106         *r = jsval_bool(This->atend);
 107     return S_OK;
 108 }
 109
 110 static HRESULT Enumerator_item(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
 111         jsval_t *r)
 112 {
 113     EnumeratorInstance *This;
 114
 115     TRACE("\n");
 116
 117     if (!(This = enumerator_this(jsthis)))
 118         return JS_E_ENUMERATOR_EXPECTED;
 119
 120     return r ? jsval_copy(This->item, r) : S_OK;
 121 }
 122
 123 static HRESULT Enumerator_moveFirst(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
 124         jsval_t *r)
 125 {
 126     EnumeratorInstance *This;
 127     HRESULT hres = S_OK;
 128
 129     TRACE("\n");
 130
 131     if (!(This = enumerator_this(jsthis)))
 132         return JS_E_ENUMERATOR_EXPECTED;
 133
 134     if (This->enumvar)
 135     {
 136         hres = IEnumVARIANT_Reset(This->enumvar);
 137         if (FAILED(hres))
 138             return hres;
 139
 140         This->atend = FALSE;
 141         hres = enumvar_get_next_item(This);
 142         if(FAILED(hres))
 143             return hres;
 144     }
 145
 146     if (r)
 147         *r = jsval_undefined();
 148     return S_OK;
 149 }
 150
 151 static HRESULT Enumerator_moveNext(script_ctx_t *ctx, vdisp_t *jsthis, WORD flags, unsigned argc, jsval_t *argv,
 152         jsval_t *r)
 153 {
 154     EnumeratorInstance *This;
 155     HRESULT hres = S_OK;
 156
 157     TRACE("\n");
 158
 159     if (!(This = enumerator_this(jsthis)))
 160         return JS_E_ENUMERATOR_EXPECTED;
 161
 162     if (This->enumvar)
 163     {
 164         hres = enumvar_get_next_item(This);
 165         if (FAILED(hres))
 166             return hres;
 167     }
 168
 169     if (r)
 170         *r = jsval_undefined();
 171     return S_OK;
 172 }
 173
 174 static const builtin_prop_t Enumerator_props[] = {
 175     {L"atEnd",     Enumerator_atEnd,     PROPF_METHOD},
 176     {L"item",      Enumerator_item,      PROPF_METHOD},
 177     {L"moveFirst", Enumerator_moveFirst, PROPF_METHOD},
 178     {L"moveNext",  Enumerator_moveNext,  PROPF_METHOD},
 179 };
 180
 181 static const builtin_info_t Enumerator_info = {
 182     JSCLASS_ENUMERATOR,
 183     {NULL, NULL, 0},
 184     ARRAY_SIZE(Enumerator_props),
 185     Enumerator_props,
 186     NULL,
 187     NULL
 188 };
 189
 190 static const builtin_info_t EnumeratorInst_info = {
 191     JSCLASS_ENUMERATOR,
 192     {NULL, NULL, 0, NULL},
 193     0,
 194     NULL,
 195     Enumerator_destructor,
 196     NULL
 197 };
 198
 199 static HRESULT alloc_enumerator(script_ctx_t *ctx, jsdisp_t *object_prototype, EnumeratorInstance **ret)
 200 {
 201     EnumeratorInstance *enumerator;
 202     HRESULT hres;
 203
 204     enumerator = heap_alloc_zero(sizeof(EnumeratorInstance));
 205     if(!enumerator)
 206         return E_OUTOFMEMORY;
 207
 208     if(object_prototype)
 209         hres = init_dispex(&enumerator->dispex, ctx, &Enumerator_info, object_prototype);
 210     else
 211         hres = init_dispex_from_constr(&enumerator->dispex, ctx, &EnumeratorInst_info,
 212                                        ctx->enumerator_constr);
 213
 214     if(FAILED(hres))
 215     {
 216         heap_free(enumerator);
 217         return hres;
 218     }
 219
 220     *ret = enumerator;
 221     return S_OK;
 222 }
 223
 224 static HRESULT create_enumerator(script_ctx_t *ctx, jsval_t *argv, jsdisp_t **ret)
 225 {
 226     EnumeratorInstance *enumerator;
 227     HRESULT hres;
 228     IDispatch *obj;
 229     DISPPARAMS dispparams = {NULL, NULL, 0, 0};
 230     IEnumVARIANT *enumvar = NULL;
 231
 232     if (argv)
 233     {
 234         VARIANT varresult;
 235
 236         if (!is_object_instance(*argv))
 237         {
 238             FIXME("I don't know how to handle this type!\n");
 239             return E_NOTIMPL;
 240         }
 241
 242         obj = get_object(*argv);
 243
 244         /* Try to get a IEnumVARIANT by _NewEnum */
 245         VariantInit(&varresult);
 246         hres = IDispatch_Invoke(obj, DISPID_NEWENUM, &IID_NULL, LOCALE_NEUTRAL,
 247                 DISPATCH_METHOD, &dispparams, &varresult, NULL, NULL);
 248         if (FAILED(hres))
 249         {
 250             WARN("Enumerator: no DISPID_NEWENUM.\n");
 251             return E_INVALIDARG;
 252         }
 253
 254         if ((V_VT(&varresult) == VT_DISPATCH) || (V_VT(&varresult) == VT_UNKNOWN))
 255         {
 256             hres = IUnknown_QueryInterface(V_UNKNOWN(&varresult),
 257                 &IID_IEnumVARIANT, (void**)&enumvar);
 258         }
 259         else
 260         {
 261             FIXME("Enumerator: NewEnum unexpected type of varresult (%d).\n", V_VT(&varresult));
 262             hres = E_INVALIDARG;
 263         }
 264         VariantClear(&varresult);
 265         if (FAILED(hres))
 266             return hres;
 267     }
 268
 269     hres = alloc_enumerator(ctx, NULL, &enumerator);
 270     if (FAILED(hres))
 271     {
 272         if (enumvar)
 273             IEnumVARIANT_Release(enumvar);
 274         return hres;
 275     }
 276
 277     enumerator->enumvar = enumvar;
 278     enumerator->atend = !enumvar;
 279     hres = enumvar_get_next_item(enumerator);
 280     if (FAILED(hres))
 281     {
 282         jsdisp_release(&enumerator->dispex);
 283         return hres;
 284     }
 285
 286     *ret = &enumerator->dispex;
 287     return S_OK;
 288 }
 289
 290 static HRESULT EnumeratorConstr_value(script_ctx_t *ctx, vdisp_t *vthis, WORD flags, unsigned argc, jsval_t *argv,
 291         jsval_t *r)
 292 {
 293     jsdisp_t *obj;
 294     HRESULT hres;
 295
 296     TRACE("\n");
 297
 298     switch(flags) {
 299     case DISPATCH_CONSTRUCT: {
 300         if (argc > 1)
 301             return JS_E_INVALIDARG;
 302
 303         hres = create_enumerator(ctx, (argc == 1) ? &argv[0] : 0, &obj);
 304         if(FAILED(hres))
 305             return hres;
 306
 307         *r = jsval_obj(obj);
 308         break;
 309     }
 310     default:
 311         FIXME("unimplemented flags: %x\n", flags);
 312         return E_NOTIMPL;
 313     }
 314
 315     return S_OK;
 316 }
 317
 318 static const builtin_info_t EnumeratorConstr_info = {
 319     JSCLASS_FUNCTION,
 320     DEFAULT_FUNCTION_VALUE,
 321     0,
 322     NULL,
 323     NULL,
 324     NULL
 325 };
 326
 327 HRESULT create_enumerator_constr(script_ctx_t *ctx, jsdisp_t *object_prototype, jsdisp_t **ret)
 328 {
 329     EnumeratorInstance *enumerator;
 330     HRESULT hres;
 331
 332     hres = alloc_enumerator(ctx, object_prototype, &enumerator);
 333     if(FAILED(hres))
 334         return hres;
 335
 336     hres = create_builtin_constructor(ctx, EnumeratorConstr_value, L"Enumerator",
 337             &EnumeratorConstr_info, PROPF_CONSTR|7, &enumerator->dispex, ret);
 338     jsdisp_release(&enumerator->dispex);
 339
 340     return hres;
 341 }