git.oblomov.eu Git - wine/blob - dlls/vbscript/interp.c

   1 /*
   2  * Copyright 2011 Jacek Caban for CodeWeavers
   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 "vbscript.h"
  22
  23 #include "wine/debug.h"
  24
  25 WINE_DEFAULT_DEBUG_CHANNEL(vbscript);
  26
  27
  28 typedef struct {
  29     vbscode_t *code;
  30     instr_t *instr;
  31     script_ctx_t *script;
  32     function_t *func;
  33
  34     unsigned stack_size;
  35     unsigned top;
  36     VARIANT *stack;
  37 } exec_ctx_t;
  38
  39 typedef HRESULT (*instr_func_t)(exec_ctx_t*);
  40
  41 typedef enum {
  42     REF_NONE,
  43     REF_DISP,
  44     REF_VAR
  45 } ref_type_t;
  46
  47 typedef struct {
  48     ref_type_t type;
  49     union {
  50         struct {
  51             IDispatch *disp;
  52             DISPID id;
  53         } d;
  54         VARIANT *v;
  55     } u;
  56 } ref_t;
  57
  58 typedef struct {
  59     VARIANT *v;
  60     VARIANT store;
  61     BOOL owned;
  62 } variant_val_t;
  63
  64 static BOOL lookup_dynamic_vars(dynamic_var_t *var, const WCHAR *name, ref_t *ref)
  65 {
  66     while(var) {
  67         if(!strcmpiW(var->name, name)) {
  68             ref->type = REF_VAR;
  69             ref->u.v = &var->v;
  70             return TRUE;
  71         }
  72
  73         var = var->next;
  74     }
  75
  76     return FALSE;
  77 }
  78
  79 static HRESULT lookup_identifier(exec_ctx_t *ctx, BSTR name, ref_t *ref)
  80 {
  81     named_item_t *item;
  82     DISPID id;
  83     HRESULT hres;
  84
  85     if(lookup_dynamic_vars(ctx->script->global_vars, name, ref))
  86         return S_OK;
  87
  88     LIST_FOR_EACH_ENTRY(item, &ctx->script->named_items, named_item_t, entry) {
  89         if(item->flags & SCRIPTITEM_GLOBALMEMBERS) {
  90             hres = disp_get_id(item->disp, name, &id);
  91             if(SUCCEEDED(hres)) {
  92                 ref->type = REF_DISP;
  93                 ref->u.d.disp = item->disp;
  94                 ref->u.d.id = id;
  95                 return S_OK;
  96             }
  97         }
  98     }
  99
 100     if(!ctx->func->code_ctx->option_explicit)
 101         FIXME("create an attempt to set\n");
 102
 103     ref->type = REF_NONE;
 104     return S_OK;
 105 }
 106
 107 static inline VARIANT *stack_pop(exec_ctx_t *ctx)
 108 {
 109     assert(ctx->top);
 110     return ctx->stack + --ctx->top;
 111 }
 112
 113 static HRESULT stack_push(exec_ctx_t *ctx, VARIANT *v)
 114 {
 115     if(ctx->stack_size == ctx->top) {
 116         VARIANT *new_stack;
 117
 118         new_stack = heap_realloc(ctx->stack, ctx->stack_size*2);
 119         if(!new_stack) {
 120             VariantClear(v);
 121             return E_OUTOFMEMORY;
 122         }
 123
 124         ctx->stack = new_stack;
 125         ctx->stack_size *= 2;
 126     }
 127
 128     ctx->stack[ctx->top++] = *v;
 129     return S_OK;
 130 }
 131
 132 static void stack_popn(exec_ctx_t *ctx, unsigned n)
 133 {
 134     while(n--)
 135         VariantClear(stack_pop(ctx));
 136 }
 137
 138 static HRESULT stack_pop_val(exec_ctx_t *ctx, variant_val_t *v)
 139 {
 140     VARIANT *var;
 141
 142     var = stack_pop(ctx);
 143
 144     if(V_VT(var) == (VT_BYREF|VT_VARIANT)) {
 145         v->owned = FALSE;
 146         var = V_VARIANTREF(var);
 147     }else {
 148         v->owned = TRUE;
 149     }
 150
 151     if(V_VT(var) == VT_DISPATCH) {
 152         FIXME("got dispatch - get its default value\n");
 153         return E_NOTIMPL;
 154     }else {
 155         v->v = var;
 156     }
 157
 158     return S_OK;
 159 }
 160
 161 static inline void release_val(variant_val_t *v)
 162 {
 163     if(v->owned)
 164         VariantClear(v->v);
 165 }
 166
 167 static HRESULT stack_pop_disp(exec_ctx_t *ctx, IDispatch **ret)
 168 {
 169     VARIANT *v = stack_pop(ctx);
 170
 171     if(V_VT(v) == VT_DISPATCH) {
 172         *ret = V_DISPATCH(v);
 173         return S_OK;
 174     }
 175
 176     if(V_VT(v) != (VT_VARIANT|VT_BYREF)) {
 177         FIXME("not supported type: %s\n", debugstr_variant(v));
 178         VariantClear(v);
 179         return E_FAIL;
 180     }
 181
 182     v = V_BYREF(v);
 183     if(V_VT(v) != VT_DISPATCH) {
 184         FIXME("not disp %s\n", debugstr_variant(v));
 185         return E_FAIL;
 186     }
 187
 188     if(V_DISPATCH(v))
 189         IDispatch_AddRef(V_DISPATCH(v));
 190     *ret = V_DISPATCH(v);
 191     return S_OK;
 192 }
 193
 194 static inline void instr_jmp(exec_ctx_t *ctx, unsigned addr)
 195 {
 196     ctx->instr = ctx->code->instrs + addr;
 197 }
 198
 199 static void vbstack_to_dp(exec_ctx_t *ctx, unsigned arg_cnt, DISPPARAMS *dp)
 200 {
 201     dp->cArgs = arg_cnt;
 202     dp->rgdispidNamedArgs = NULL;
 203     dp->cNamedArgs = 0;
 204
 205     if(arg_cnt) {
 206         VARIANT tmp;
 207         unsigned i;
 208
 209         assert(ctx->top >= arg_cnt);
 210
 211         for(i=1; i*2 <= arg_cnt; i++) {
 212             tmp = ctx->stack[ctx->top-i];
 213             ctx->stack[ctx->top-i] = ctx->stack[ctx->top-arg_cnt+i-1];
 214             ctx->stack[ctx->top-arg_cnt+i-1] = tmp;
 215         }
 216
 217         dp->rgvarg = ctx->stack + ctx->top-arg_cnt;
 218     }else {
 219         dp->rgvarg = NULL;
 220     }
 221 }
 222
 223 static HRESULT do_icall(exec_ctx_t *ctx, VARIANT *res)
 224 {
 225     BSTR identifier = ctx->instr->arg1.bstr;
 226     const unsigned arg_cnt = ctx->instr->arg2.uint;
 227     ref_t ref = {0};
 228     DISPPARAMS dp;
 229     HRESULT hres;
 230
 231     hres = lookup_identifier(ctx, identifier, &ref);
 232     if(FAILED(hres))
 233         return hres;
 234
 235     vbstack_to_dp(ctx, arg_cnt, &dp);
 236
 237     switch(ref.type) {
 238     case REF_VAR:
 239         if(!res) {
 240             FIXME("REF_VAR no res\n");
 241             return E_NOTIMPL;
 242         }
 243
 244         if(arg_cnt) {
 245             FIXME("arguments not implemented\n");
 246             return E_NOTIMPL;
 247         }
 248
 249         V_VT(res) = VT_BYREF|VT_VARIANT;
 250         V_BYREF(res) = V_VT(ref.u.v) == (VT_VARIANT|VT_BYREF) ? V_VARIANTREF(ref.u.v) : ref.u.v;
 251         break;
 252     case REF_DISP:
 253         hres = disp_call(ctx->script, ref.u.d.disp, ref.u.d.id, &dp, res);
 254         if(FAILED(hres))
 255             return hres;
 256         break;
 257     case REF_NONE:
 258         FIXME("%s not found\n", debugstr_w(identifier));
 259         return DISP_E_UNKNOWNNAME;
 260     }
 261
 262     stack_popn(ctx, arg_cnt);
 263     return S_OK;
 264 }
 265
 266 static HRESULT interp_icall(exec_ctx_t *ctx)
 267 {
 268     VARIANT v;
 269     HRESULT hres;
 270
 271     TRACE("\n");
 272
 273     hres = do_icall(ctx, &v);
 274     if(FAILED(hres))
 275         return hres;
 276
 277     return stack_push(ctx, &v);
 278 }
 279
 280 static HRESULT interp_icallv(exec_ctx_t *ctx)
 281 {
 282     TRACE("\n");
 283     return do_icall(ctx, NULL);
 284 }
 285
 286 static HRESULT assign_ident(exec_ctx_t *ctx, BSTR name, VARIANT *val, BOOL own_val)
 287 {
 288     ref_t ref;
 289     HRESULT hres;
 290
 291     hres = lookup_identifier(ctx, name, &ref);
 292     if(FAILED(hres))
 293         return hres;
 294
 295     switch(ref.type) {
 296     case REF_VAR: {
 297         VARIANT *v = ref.u.v;
 298
 299         if(V_VT(v) == (VT_VARIANT|VT_BYREF))
 300             v = V_VARIANTREF(v);
 301
 302         if(own_val) {
 303             VariantClear(v);
 304             *v = *val;
 305             hres = S_OK;
 306         }else {
 307             hres = VariantCopy(v, val);
 308         }
 309         break;
 310     }
 311     case REF_DISP:
 312         hres = disp_propput(ctx->script, ref.u.d.disp, ref.u.d.id, val);
 313         if(own_val)
 314             VariantClear(val);
 315         break;
 316     case REF_NONE:
 317         FIXME("%s not found\n", debugstr_w(name));
 318         if(own_val)
 319             VariantClear(val);
 320         return DISP_E_UNKNOWNNAME;
 321     }
 322
 323     return hres;
 324 }
 325
 326 static HRESULT interp_assign_ident(exec_ctx_t *ctx)
 327 {
 328     const BSTR arg = ctx->instr->arg1.bstr;
 329     variant_val_t v;
 330     HRESULT hres;
 331
 332     TRACE("%s\n", debugstr_w(arg));
 333
 334     hres = stack_pop_val(ctx, &v);
 335     if(FAILED(hres))
 336         return hres;
 337
 338     return assign_ident(ctx, arg, v.v, v.owned);
 339 }
 340
 341 static HRESULT interp_assign_member(exec_ctx_t *ctx)
 342 {
 343     BSTR identifier = ctx->instr->arg1.bstr;
 344     variant_val_t val;
 345     IDispatch *obj;
 346     DISPID id;
 347     HRESULT hres;
 348
 349     TRACE("%s\n", debugstr_w(identifier));
 350
 351     hres = stack_pop_disp(ctx, &obj);
 352     if(FAILED(hres))
 353         return hres;
 354
 355     if(!obj) {
 356         FIXME("NULL obj\n");
 357         return E_FAIL;
 358     }
 359
 360     hres = stack_pop_val(ctx, &val);
 361     if(FAILED(hres)) {
 362         IDispatch_Release(obj);
 363         return hres;
 364     }
 365
 366     hres = disp_get_id(obj, identifier, &id);
 367     if(SUCCEEDED(hres))
 368         hres = disp_propput(ctx->script, obj, id, val.v);
 369
 370     release_val(&val);
 371     IDispatch_Release(obj);
 372     return hres;
 373 }
 374
 375 static HRESULT interp_jmp(exec_ctx_t *ctx)
 376 {
 377     const unsigned arg = ctx->instr->arg1.uint;
 378
 379     TRACE("%u\n", arg);
 380
 381     instr_jmp(ctx, arg);
 382     return S_OK;
 383 }
 384
 385 static HRESULT interp_jmp_false(exec_ctx_t *ctx)
 386 {
 387     const unsigned arg = ctx->instr->arg1.uint;
 388     variant_val_t val;
 389     HRESULT hres;
 390
 391     TRACE("%u\n", arg);
 392
 393     hres = stack_pop_val(ctx, &val);
 394     if(V_VT(val.v) != VT_BOOL) {
 395         FIXME("unsupported for %s\n", debugstr_variant(val.v));
 396         release_val(&val);
 397         return E_NOTIMPL;
 398     }
 399
 400     if(V_BOOL(val.v))
 401         ctx->instr++;
 402     else
 403         instr_jmp(ctx, ctx->instr->arg1.uint);
 404     return S_OK;
 405 }
 406
 407 static HRESULT interp_ret(exec_ctx_t *ctx)
 408 {
 409     TRACE("\n");
 410
 411     ctx->instr = NULL;
 412     return S_OK;
 413 }
 414
 415 static HRESULT interp_bool(exec_ctx_t *ctx)
 416 {
 417     const VARIANT_BOOL arg = ctx->instr->arg1.lng;
 418     VARIANT v;
 419
 420     TRACE("%s\n", arg ? "true" : "false");
 421
 422     V_VT(&v) = VT_BOOL;
 423     V_BOOL(&v) = arg;
 424     return stack_push(ctx, &v);
 425 }
 426
 427 static HRESULT interp_string(exec_ctx_t *ctx)
 428 {
 429     VARIANT v;
 430
 431     TRACE("\n");
 432
 433     V_VT(&v) = VT_BSTR;
 434     V_BSTR(&v) = SysAllocString(ctx->instr->arg1.str);
 435     if(!V_BSTR(&v))
 436         return E_OUTOFMEMORY;
 437
 438     return stack_push(ctx, &v);
 439 }
 440
 441 static HRESULT interp_long(exec_ctx_t *ctx)
 442 {
 443     const LONG arg = ctx->instr->arg1.lng;
 444     VARIANT v;
 445
 446     TRACE("%d\n", arg);
 447
 448     V_VT(&v) = VT_I4;
 449     V_I4(&v) = arg;
 450     return stack_push(ctx, &v);
 451 }
 452
 453 static HRESULT interp_short(exec_ctx_t *ctx)
 454 {
 455     const LONG arg = ctx->instr->arg1.lng;
 456     VARIANT v;
 457
 458     TRACE("%d\n", arg);
 459
 460     V_VT(&v) = VT_I2;
 461     V_I2(&v) = arg;
 462     return stack_push(ctx, &v);
 463 }
 464
 465 static HRESULT interp_double(exec_ctx_t *ctx)
 466 {
 467     const DOUBLE *arg = ctx->instr->arg1.dbl;
 468     VARIANT v;
 469
 470     TRACE("%lf\n", *arg);
 471
 472     V_VT(&v) = VT_R8;
 473     V_R8(&v) = *arg;
 474     return stack_push(ctx, &v);
 475 }
 476
 477 static HRESULT interp_empty(exec_ctx_t *ctx)
 478 {
 479     VARIANT v;
 480
 481     TRACE("\n");
 482
 483     V_VT(&v) = VT_EMPTY;
 484     return stack_push(ctx, &v);
 485 }
 486
 487 static HRESULT interp_null(exec_ctx_t *ctx)
 488 {
 489     VARIANT v;
 490
 491     TRACE("\n");
 492
 493     V_VT(&v) = VT_NULL;
 494     return stack_push(ctx, &v);
 495 }
 496
 497 static HRESULT interp_not(exec_ctx_t *ctx)
 498 {
 499     variant_val_t val;
 500     VARIANT v;
 501     HRESULT hres;
 502
 503     TRACE("\n");
 504
 505     hres = stack_pop_val(ctx, &val);
 506     if(FAILED(hres))
 507         return hres;
 508
 509     hres = VarNot(val.v, &v);
 510     release_val(&val);
 511     if(FAILED(hres))
 512         return hres;
 513
 514     return stack_push(ctx, &v);
 515 }
 516
 517 static HRESULT cmp_oper(exec_ctx_t *ctx)
 518 {
 519     variant_val_t l, r;
 520     HRESULT hres;
 521
 522     hres = stack_pop_val(ctx, &r);
 523     if(FAILED(hres))
 524         return hres;
 525
 526     hres = stack_pop_val(ctx, &l);
 527     if(SUCCEEDED(hres)) {
 528         if(V_VT(l.v) == VT_NULL || V_VT(r.v) == VT_NULL) {
 529             FIXME("comparing nulls is not implemented\n");
 530             hres = E_NOTIMPL;
 531         }else {
 532             hres = VarCmp(l.v, r.v, ctx->script->lcid, 0);
 533         }
 534     }
 535
 536     release_val(&r);
 537     release_val(&l);
 538     return hres;
 539 }
 540
 541 static HRESULT interp_equal(exec_ctx_t *ctx)
 542 {
 543     VARIANT v;
 544     HRESULT hres;
 545
 546     TRACE("\n");
 547
 548     hres = cmp_oper(ctx);
 549     if(FAILED(hres))
 550         return hres;
 551
 552     V_VT(&v) = VT_BOOL;
 553     V_BOOL(&v) = hres == VARCMP_EQ ? VARIANT_TRUE : VARIANT_FALSE;
 554     return stack_push(ctx, &v);
 555 }
 556
 557 static HRESULT interp_nequal(exec_ctx_t *ctx)
 558 {
 559     VARIANT v;
 560     HRESULT hres;
 561
 562     TRACE("\n");
 563
 564     hres = cmp_oper(ctx);
 565     if(FAILED(hres))
 566         return hres;
 567
 568     V_VT(&v) = VT_BOOL;
 569     V_BOOL(&v) = hres != VARCMP_EQ ? VARIANT_TRUE : VARIANT_FALSE;
 570     return stack_push(ctx, &v);
 571 }
 572
 573 static HRESULT interp_concat(exec_ctx_t *ctx)
 574 {
 575     variant_val_t r, l;
 576     VARIANT v;
 577     HRESULT hres;
 578
 579     TRACE("\n");
 580
 581     hres = stack_pop_val(ctx, &r);
 582     if(FAILED(hres))
 583         return hres;
 584
 585     hres = stack_pop_val(ctx, &l);
 586     if(SUCCEEDED(hres)) {
 587         hres = VarCat(l.v, r.v, &v);
 588         release_val(&l);
 589     }
 590     release_val(&r);
 591     if(FAILED(hres))
 592         return hres;
 593
 594     return stack_push(ctx, &v);
 595 }
 596
 597 static HRESULT interp_add(exec_ctx_t *ctx)
 598 {
 599     variant_val_t r, l;
 600     VARIANT v;
 601     HRESULT hres;
 602
 603     TRACE("\n");
 604
 605     hres = stack_pop_val(ctx, &r);
 606     if(FAILED(hres))
 607         return hres;
 608
 609     hres = stack_pop_val(ctx, &l);
 610     if(SUCCEEDED(hres)) {
 611         hres = VarAdd(l.v, r.v, &v);
 612         release_val(&l);
 613     }
 614     release_val(&r);
 615     if(FAILED(hres))
 616         return hres;
 617
 618     return stack_push(ctx, &v);
 619 }
 620
 621 static HRESULT interp_sub(exec_ctx_t *ctx)
 622 {
 623     variant_val_t r, l;
 624     VARIANT v;
 625     HRESULT hres;
 626
 627     TRACE("\n");
 628
 629     hres = stack_pop_val(ctx, &r);
 630     if(FAILED(hres))
 631         return hres;
 632
 633     hres = stack_pop_val(ctx, &l);
 634     if(SUCCEEDED(hres)) {
 635         hres = VarSub(l.v, r.v, &v);
 636         release_val(&l);
 637     }
 638     release_val(&r);
 639     if(FAILED(hres))
 640         return hres;
 641
 642     return stack_push(ctx, &v);
 643 }
 644
 645 static HRESULT interp_neg(exec_ctx_t *ctx)
 646 {
 647     variant_val_t val;
 648     VARIANT v;
 649     HRESULT hres;
 650
 651     hres = stack_pop_val(ctx, &val);
 652     if(FAILED(hres))
 653         return hres;
 654
 655     hres = VarNeg(val.v, &v);
 656     release_val(&val);
 657     if(FAILED(hres))
 658         return hres;
 659
 660     return stack_push(ctx, &v);
 661 }
 662
 663 static const instr_func_t op_funcs[] = {
 664 #define X(x,n,a,b) interp_ ## x,
 665 OP_LIST
 666 #undef X
 667 };
 668
 669 static const unsigned op_move[] = {
 670 #define X(x,n,a,b) n,
 671 OP_LIST
 672 #undef X
 673 };
 674
 675 HRESULT exec_script(script_ctx_t *ctx, function_t *func)
 676 {
 677     exec_ctx_t exec;
 678     vbsop_t op;
 679     HRESULT hres = S_OK;
 680
 681     exec.stack_size = 16;
 682     exec.top = 0;
 683     exec.stack = heap_alloc(exec.stack_size * sizeof(VARIANT));
 684     if(!exec.stack)
 685         return E_OUTOFMEMORY;
 686
 687     exec.code = func->code_ctx;
 688     exec.instr = exec.code->instrs + func->code_off;
 689     exec.script = ctx;
 690     exec.func = func;
 691
 692     while(exec.instr) {
 693         op = exec.instr->op;
 694         hres = op_funcs[op](&exec);
 695         if(FAILED(hres)) {
 696             FIXME("Failed %08x\n", hres);
 697             stack_popn(&exec, exec.top);
 698             break;
 699         }
 700
 701         exec.instr += op_move[op];
 702     }
 703
 704     assert(!exec.top);
 705     heap_free(exec.stack);
 706
 707     return hres;
 708 }