/
args.c
1863 lines (1542 loc) · 61.8 KB
/
args.c
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright (C) 2001-2011, Parrot Foundation.
=head1 NAME
src/call/args.c
=head1 DESCRIPTION
B<Arguments and Returns>: Functions in this file handle argument/return value
passing to and from subroutines following the Parrot Calling Conventions.
=head1 FUNCTIONS
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "parrot/oplib/ops.h"
#include "args.str"
#include "pmc/pmc_key.h"
#include "pmc/pmc_fixedintegerarray.h"
#include "pmc/pmc_callcontext.h"
/* HEADERIZER HFILE: include/parrot/call.h */
/*
Set of functions used in generic versions of fill_params and fill_returns.
*/
typedef INTVAL* (*intval_ptr_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef FLOATVAL* (*numval_ptr_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef STRING** (*string_ptr_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef PMC** (*pmc_ptr_func_t) (PARROT_INTERP, void *arg_info, INTVAL index);
typedef INTVAL (*intval_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef FLOATVAL (*numval_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef STRING* (*string_func_t)(PARROT_INTERP, void *arg_info, INTVAL index);
typedef PMC* (*pmc_func_t) (PARROT_INTERP, void *arg_info, INTVAL index);
typedef struct pcc_funcs_ptr {
intval_ptr_func_t intval;
numval_ptr_func_t numval;
string_ptr_func_t string;
pmc_ptr_func_t pmc;
intval_func_t intval_constant;
numval_func_t numval_constant;
string_func_t string_constant;
pmc_func_t pmc_constant;
} pcc_funcs_ptr;
/* HEADERIZER BEGIN: static */
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
static void assign_default_param_value(PARROT_INTERP,
INTVAL param_index,
INTVAL param_flags,
ARGIN(void *arg_info),
ARGIN(const struct pcc_funcs_ptr *accessor))
__attribute__nonnull__(1)
__attribute__nonnull__(4)
__attribute__nonnull__(5);
static void dissect_aggregate_arg(PARROT_INTERP,
ARGMOD(PMC *call_object),
ARGIN(PMC *aggregate))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*call_object);
static void extract_named_arg_from_op(PARROT_INTERP,
ARGMOD(PMC *call_object),
ARGIN(STRING *name),
ARGIN(PMC *raw_sig),
ARGIN(opcode_t *raw_args),
INTVAL arg_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
__attribute__nonnull__(5)
FUNC_MODIFIES(*call_object);
static void fill_params(PARROT_INTERP,
ARGMOD_NULLOK(PMC *call_object),
ARGIN(PMC *raw_sig),
ARGIN(void *arg_info),
ARGIN(const struct pcc_funcs_ptr *accessor),
Errors_classes direction)
__attribute__nonnull__(1)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
__attribute__nonnull__(5)
FUNC_MODIFIES(*call_object);
PARROT_WARN_UNUSED_RESULT
static INTVAL intval_constant_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
static INTVAL intval_constant_from_varargs(PARROT_INTERP,
ARGIN(void *data),
INTVAL index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static INTVAL* intval_param_from_c_args(PARROT_INTERP,
ARGIN(va_list *args),
INTVAL param_index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static INTVAL* intval_param_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_COLD
PARROT_DOES_NOT_RETURN
static void named_argument_arity_error(PARROT_INTERP,
int named_arg_count,
ARGFREE(Hash *named_used_list),
ARGIN(Hash *named_arg_list))
__attribute__nonnull__(1)
__attribute__nonnull__(4);
PARROT_WARN_UNUSED_RESULT
static FLOATVAL numval_constant_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
static FLOATVAL numval_constant_from_varargs(PARROT_INTERP,
ARGIN(void *data),
INTVAL index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static FLOATVAL* numval_param_from_c_args(PARROT_INTERP,
ARGIN(va_list *args),
INTVAL param_index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static FLOATVAL* numval_param_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static void parse_signature_string(PARROT_INTERP,
ARGIN(const char *signature),
ARGMOD(PMC **arg_flags))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
FUNC_MODIFIES(*arg_flags);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static PMC* pmc_constant_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static PMC* pmc_constant_from_varargs(PARROT_INTERP,
ARGIN(void *data),
INTVAL index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC** pmc_param_from_c_args(PARROT_INTERP,
ARGIN(va_list *args),
INTVAL param_index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static PMC** pmc_param_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
static void set_call_from_varargs(PARROT_INTERP,
ARGIN(PMC *signature),
ARGIN(const char *sig),
ARGMOD(va_list *args))
__attribute__nonnull__(1)
__attribute__nonnull__(2)
__attribute__nonnull__(3)
__attribute__nonnull__(4)
FUNC_MODIFIES(*args);
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
static STRING* string_constant_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
static STRING* string_constant_from_varargs(PARROT_INTERP,
ARGIN(void *data),
INTVAL index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static STRING** string_param_from_c_args(PARROT_INTERP,
ARGIN(va_list *args),
INTVAL param_index)
__attribute__nonnull__(2);
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
static STRING** string_param_from_op(PARROT_INTERP,
ARGIN(const opcode_t *raw_params),
INTVAL param_index)
__attribute__nonnull__(1)
__attribute__nonnull__(2);
#define ASSERT_ARGS_assign_default_param_value __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(arg_info) \
, PARROT_ASSERT_ARG(accessor))
#define ASSERT_ARGS_dissect_aggregate_arg __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(call_object) \
, PARROT_ASSERT_ARG(aggregate))
#define ASSERT_ARGS_extract_named_arg_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(call_object) \
, PARROT_ASSERT_ARG(name) \
, PARROT_ASSERT_ARG(raw_sig) \
, PARROT_ASSERT_ARG(raw_args))
#define ASSERT_ARGS_fill_params __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_sig) \
, PARROT_ASSERT_ARG(arg_info) \
, PARROT_ASSERT_ARG(accessor))
#define ASSERT_ARGS_intval_constant_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_intval_constant_from_varargs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(data_unused))
#define ASSERT_ARGS_intval_param_from_c_args __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_intval_param_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_named_argument_arity_error __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(named_arg_list))
#define ASSERT_ARGS_numval_constant_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_numval_constant_from_varargs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(data_unused))
#define ASSERT_ARGS_numval_param_from_c_args __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_numval_param_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_parse_signature_string __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(signature) \
, PARROT_ASSERT_ARG(arg_flags))
#define ASSERT_ARGS_pmc_constant_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_pmc_constant_from_varargs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(data_unused))
#define ASSERT_ARGS_pmc_param_from_c_args __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_pmc_param_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_set_call_from_varargs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(signature) \
, PARROT_ASSERT_ARG(sig) \
, PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_string_constant_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
#define ASSERT_ARGS_string_constant_from_varargs __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(data_unused))
#define ASSERT_ARGS_string_param_from_c_args __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(args))
#define ASSERT_ARGS_string_param_from_op __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
PARROT_ASSERT_ARG(interp) \
, PARROT_ASSERT_ARG(raw_params))
/* Don't modify between HEADERIZER BEGIN / HEADERIZER END. Your changes will be lost. */
/* HEADERIZER END: static */
/*
=item C<PMC* Parrot_pcc_build_sig_object_from_op(PARROT_INTERP, PMC *signature,
PMC *raw_sig, opcode_t *raw_args)>
Take a raw signature and argument list from a set_args opcode and
convert it to a CallContext PMC.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pcc_build_sig_object_from_op(PARROT_INTERP, ARGIN_NULLOK(PMC *signature),
ARGIN(PMC *raw_sig), ARGIN(opcode_t *raw_args))
{
ASSERT_ARGS(Parrot_pcc_build_sig_object_from_op)
PMC * const ctx = CURRENT_CONTEXT(interp);
PMC *call_object;
INTVAL *int_array;
INTVAL arg_count;
INTVAL arg_index = 0;
INTVAL arg_named_count = 0;
if (PMC_IS_NULL(signature))
call_object = Parrot_pmc_new(interp, enum_class_CallContext);
else {
call_object = signature;
VTABLE_morph(interp, call_object, PMCNULL);
}
/* this macro is much, much faster than the VTABLE STRING comparisons */
PARROT_GC_WRITE_BARRIER(interp, call_object);
SETATTR_CallContext_arg_flags(interp, call_object, raw_sig);
GETATTR_FixedIntegerArray_size(interp, raw_sig, arg_count);
GETATTR_FixedIntegerArray_int_array(interp, raw_sig, int_array);
for (; arg_index < arg_count; ++arg_index) {
const INTVAL arg_flags = int_array[arg_index];
const int constant = 0 != PARROT_ARG_CONSTANT_ISSET(arg_flags);
const INTVAL raw_index = raw_args[arg_index + 2];
if (arg_named_count && !(arg_flags & PARROT_ARG_NAME))
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"named arguments must follow all positional arguments");
switch (PARROT_ARG_TYPE_MASK_MASK(arg_flags)) {
case PARROT_ARG_INTVAL:
VTABLE_push_integer(interp, call_object, constant
? raw_index
: CTX_REG_INT(interp, ctx, raw_index));
break;
case PARROT_ARG_FLOATVAL:
VTABLE_push_float(interp, call_object, constant
? Parrot_pcc_get_num_constant(interp, ctx, raw_index)
: CTX_REG_NUM(interp, ctx, raw_index));
break;
case PARROT_ARG_STRING:
{
STRING * const string_value = constant
? Parrot_pcc_get_string_constant(interp, ctx, raw_index)
: CTX_REG_STR(interp, ctx, raw_index);
if (arg_flags & PARROT_ARG_NAME) {
++arg_index;
++arg_named_count;
if (!PMC_IS_NULL(call_object)
&& VTABLE_exists_keyed_str(interp, call_object, string_value)) {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"duplicate named argument in call");
}
extract_named_arg_from_op(interp, call_object, string_value,
raw_sig, raw_args, arg_index);
}
else
VTABLE_push_string(interp, call_object, string_value);
break;
}
case PARROT_ARG_PMC:
{
PMC * const pmc_value = constant
? Parrot_pcc_get_pmc_constant(interp, ctx, raw_index)
: CTX_REG_PMC(interp, ctx, raw_index);
if (arg_flags & PARROT_ARG_FLATTEN) {
dissect_aggregate_arg(interp, call_object, pmc_value);
}
else {
VTABLE_push_pmc(interp, call_object, pmc_value);
}
break;
}
default:
break;
}
}
return call_object;
}
/*
=item C<static void extract_named_arg_from_op(PARROT_INTERP, PMC *call_object,
STRING *name, PMC *raw_sig, opcode_t *raw_args, INTVAL arg_index)>
Pulls in the next argument from a set_args opcode, and sets it as the
value of a named argument in the CallContext PMC.
=cut
*/
static void
extract_named_arg_from_op(PARROT_INTERP, ARGMOD(PMC *call_object), ARGIN(STRING *name),
ARGIN(PMC *raw_sig), ARGIN(opcode_t *raw_args), INTVAL arg_index)
{
ASSERT_ARGS(extract_named_arg_from_op)
PMC * const ctx = CURRENT_CONTEXT(interp);
const INTVAL arg_flags = VTABLE_get_integer_keyed_int(interp, raw_sig, arg_index);
const int constant = 0 != PARROT_ARG_CONSTANT_ISSET(arg_flags);
const INTVAL raw_index = raw_args[arg_index + 2];
switch (PARROT_ARG_TYPE_MASK_MASK(arg_flags)) {
case PARROT_ARG_INTVAL:
VTABLE_set_integer_keyed_str(interp, call_object, name, constant
? raw_index
: CTX_REG_INT(interp, ctx, raw_index));
break;
case PARROT_ARG_FLOATVAL:
VTABLE_set_number_keyed_str(interp, call_object, name, constant
? Parrot_pcc_get_num_constant(interp, ctx, raw_index)
: CTX_REG_NUM(interp, ctx, raw_index));
break;
case PARROT_ARG_STRING:
VTABLE_set_string_keyed_str(interp, call_object, name, constant
? Parrot_pcc_get_string_constant(interp, ctx, raw_index)
: CTX_REG_STR(interp, ctx, raw_index));
break;
case PARROT_ARG_PMC:
VTABLE_set_pmc_keyed_str(interp, call_object, name, constant
? Parrot_pcc_get_pmc_constant(interp, ctx, raw_index)
: CTX_REG_PMC(interp, ctx, raw_index));
break;
default:
break;
}
}
/*
=item C<static void dissect_aggregate_arg(PARROT_INTERP, PMC *call_object, PMC
*aggregate)>
Takes an aggregate PMC and splits it up into individual arguments,
adding each one to the CallContext PMC. If the aggregate is an array,
its elements are added as positional arguments. If the aggregate is a
hash, its key/value pairs are added as named arguments.
=cut
*/
static void
dissect_aggregate_arg(PARROT_INTERP, ARGMOD(PMC *call_object), ARGIN(PMC *aggregate))
{
ASSERT_ARGS(dissect_aggregate_arg)
if (VTABLE_does(interp, aggregate, CONST_STRING(interp, "array"))) {
const INTVAL elements = VTABLE_elements(interp, aggregate);
INTVAL index;
for (index = 0; index < elements; ++index) {
VTABLE_push_pmc(interp, call_object,
VTABLE_get_pmc_keyed_int(interp, aggregate, index));
}
}
else if (VTABLE_does(interp, aggregate, CONST_STRING(interp, "hash"))) {
const Hash * const hash = (Hash *)VTABLE_get_pointer(interp, aggregate);
parrot_hash_iterate(hash,
VTABLE_set_pmc_keyed_str(interp, call_object,
(STRING *)_bucket->key,
Parrot_hash_value_to_pmc(interp, hash, _bucket->value)););
}
else {
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"flattened parameters must be a hash or array");
}
}
/*
=item C<void Parrot_pcc_set_call_from_c_args(PARROT_INTERP, PMC *signature,
const char *sig, ...)>
Converts a variable list of C args into an existent CallContext PMC.
The CallContext stores the original short signature string and an array of
integer types to pass on to the multiple dispatch search.
=cut
*/
PARROT_EXPORT
void
Parrot_pcc_set_call_from_c_args(PARROT_INTERP,
ARGIN(PMC *signature), ARGIN(const char *sig), ...)
{
ASSERT_ARGS(Parrot_pcc_set_call_from_c_args)
va_list args;
va_start(args, sig);
Parrot_pcc_set_call_from_varargs(interp, signature,
sig, &args);
va_end(args);
}
/*
=item C<PMC* Parrot_pcc_build_call_from_c_args(PARROT_INTERP, PMC *signature,
const char *sig, ...)>
Converts a variable list of C args into a CallContext PMC, creating a new one
if needed. The CallContext stores the original short signature string and an
array of integer types to pass on to the multiple dispatch search.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pcc_build_call_from_c_args(PARROT_INTERP,
ARGIN_NULLOK(PMC *signature), ARGIN(const char *sig), ...)
{
ASSERT_ARGS(Parrot_pcc_build_call_from_c_args)
PMC *call_object;
va_list args;
va_start(args, sig);
call_object = Parrot_pcc_build_call_from_varargs(interp, signature,
sig, &args);
va_end(args);
return call_object;
}
/*
=item C<static void set_call_from_varargs(PARROT_INTERP, PMC *signature, const
char *sig, va_list *args)>
Helper for Parrot_pcc_build_call_from_varargs and Parrot_pcc_set_call_from_varargs.
=cut
*/
static void
set_call_from_varargs(PARROT_INTERP,
ARGIN(PMC *signature), ARGIN(const char *sig),
ARGMOD(va_list *args))
{
ASSERT_ARGS(set_call_from_varargs)
PMC *arg_flags = PMCNULL;
INTVAL i = 0;
parse_signature_string(interp, sig, &arg_flags);
SETATTR_CallContext_arg_flags(interp, signature, arg_flags);
/* Process the varargs list */
for (; sig[i] != '\0'; ++i) {
const INTVAL type = sig[i];
/* Regular arguments just set the value */
switch (type) {
case 'P':
{
const INTVAL type_lookahead = sig[i+1];
PMC * const pmc_arg = va_arg(*args, PMC *);
if (type_lookahead == 'f') {
dissect_aggregate_arg(interp, signature, pmc_arg);
++i; /* skip 'f' */
}
else if (type_lookahead == 'i') {
if (i)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Dispatch: only the first argument can be an invocant");
else {
VTABLE_push_pmc(interp, signature, pmc_arg);
++i; /* skip 'i' */
}
}
else
VTABLE_push_pmc(interp, signature, pmc_arg);
break;
}
case 'S':
VTABLE_push_string(interp, signature, va_arg(*args, STRING *));
break;
case 'I':
VTABLE_push_integer(interp, signature, va_arg(*args, INTVAL));
break;
case 'N':
VTABLE_push_float(interp, signature, va_arg(*args, FLOATVAL));
break;
case '-':
return;
break;
default:
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Dispatch: invalid argument type %c!", type);
}
}
}
/*
=item C<void Parrot_pcc_set_call_from_varargs(PARROT_INTERP, PMC *signature,
const char *sig, va_list *args)>
Converts a varargs list into an existent CallContext PMC.
The CallContext stores the original short signature string and an array of
integer types to pass on to the multiple dispatch search.
=cut
*/
PARROT_EXPORT
void
Parrot_pcc_set_call_from_varargs(PARROT_INTERP,
ARGIN(PMC *signature), ARGIN(const char *sig),
ARGMOD(va_list *args))
{
ASSERT_ARGS(Parrot_pcc_set_call_from_varargs)
PARROT_ASSERT(PMCNULL != signature);
VTABLE_morph(interp, signature, PMCNULL);
set_call_from_varargs(interp, signature, sig, args);
}
/*
=item C<PMC* Parrot_pcc_build_call_from_varargs(PARROT_INTERP, PMC *signature,
const char *sig, va_list *args)>
Converts a varargs list into a CallContext PMC, creating a new one if needed.
The CallContext stores the original short signature string and an array of
integer types to pass on to the multiple dispatch search.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pcc_build_call_from_varargs(PARROT_INTERP,
ARGIN_NULLOK(PMC *signature), ARGIN(const char *sig),
ARGMOD(va_list *args))
{
ASSERT_ARGS(Parrot_pcc_build_call_from_varargs)
PMC *call_object;
if (PMC_IS_NULL(signature))
call_object = Parrot_pmc_new(interp, enum_class_CallContext);
else {
call_object = signature;
VTABLE_morph(interp, call_object, PMCNULL);
}
set_call_from_varargs(interp, call_object, sig, args);
return call_object;
}
/*
=item C<PMC* Parrot_pcc_build_sig_object_from_varargs(PARROT_INTERP, PMC *obj,
const char *sig, va_list args)>
Converts a varargs list into a CallContext PMC. The CallContext stores the
original short signature string and an array of integer types to pass on to the
multiple dispatch search.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
PMC*
Parrot_pcc_build_sig_object_from_varargs(PARROT_INTERP, ARGIN_NULLOK(PMC *obj),
ARGIN(const char *sig), va_list args)
{
ASSERT_ARGS(Parrot_pcc_build_sig_object_from_varargs)
PMC * arg_flags = PMCNULL;
PMC * const call_object = Parrot_pmc_new(interp, enum_class_CallContext);
INTVAL in_return_sig = 0;
INTVAL i;
int append_pi = 1;
/* empty args or empty returns */
if (*sig == '-' || *sig == '\0')
return call_object;
parse_signature_string(interp, sig, &arg_flags);
SETATTR_CallContext_arg_flags(interp, call_object, arg_flags);
/* Process the varargs list */
for (i = 0; sig[i] != '\0'; ++i) {
const INTVAL type = sig[i];
/* Don't process returns */
if (in_return_sig)
break;
/* Regular arguments just set the value */
switch (type) {
case 'I':
VTABLE_push_integer(interp, call_object, va_arg(args, INTVAL));
break;
case 'N':
VTABLE_push_float(interp, call_object, va_arg(args, FLOATVAL));
break;
case 'S':
VTABLE_push_string(interp, call_object, va_arg(args, STRING *));
break;
case 'P':
{
const INTVAL type_lookahead = sig[i+1];
PMC * const pmc_arg = va_arg(args, PMC *);
if (type_lookahead == 'f') {
dissect_aggregate_arg(interp, call_object, pmc_arg);
++i; /* skip 'f' */
}
else {
VTABLE_push_pmc(interp, call_object, pmc_arg);
if (type_lookahead == 'i') {
if (i != 0)
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Dispatch: only the first argument "
"can be an invocant");
++i; /* skip 'i' */
append_pi = 0; /* Don't prepend Pi to signature */
}
}
break;
}
case '-':
in_return_sig = 1;
break;
default:
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"Dispatch: invalid argument type %c!", type);
}
}
/* Add invocant to the front of the arguments iff needed */
if (!PMC_IS_NULL(obj) && append_pi)
VTABLE_unshift_pmc(interp, call_object, obj);
return call_object;
}
/*
=item C<static void fill_params(PARROT_INTERP, PMC *call_object, PMC *raw_sig,
void *arg_info, const struct pcc_funcs_ptr *accessor, Errors_classes direction)>
Gets args for the current function call and puts them into position.
First it gets the positional non-slurpy parameters, then the positional
slurpy parameters, then the named parameters, and finally the named
slurpy parameters.
=cut
*/
static void
fill_params(PARROT_INTERP, ARGMOD_NULLOK(PMC *call_object),
ARGIN(PMC *raw_sig), ARGIN(void *arg_info),
ARGIN(const struct pcc_funcs_ptr *accessor),
Errors_classes direction)
{
ASSERT_ARGS(fill_params)
INTVAL *raw_params;
Hash *named_used_list = NULL;
INTVAL param_index = 0;
INTVAL arg_index = 0;
INTVAL named_count = 0;
INTVAL param_count;
INTVAL positional_args;
/* Check if we should be throwing errors. This is configured separately
* for parameters and return values. */
const INTVAL err_check = PARROT_ERRORS_test(interp, direction);
GETATTR_FixedIntegerArray_size(interp, raw_sig, param_count);
/* Get number of positional args */
if (PMC_IS_NULL(call_object)) {
/* A null call object is fine if there are no arguments and no returns. */
if (param_count == 0)
return;
if (err_check) {
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"too few arguments: 0 passed, %d expected", param_count);
}
positional_args = 0;
call_object = NULL; /* so we don't need to use PMC_IS_NULL below */
}
else {
GETATTR_CallContext_num_positionals(interp, call_object, positional_args);
}
GETATTR_FixedIntegerArray_int_array(interp, raw_sig, raw_params);
/* EXPERIMENTAL! This block adds provisional :call_sig param support on the
callee side only. Does not add :call_sig arg support on the caller side.
This is not the final form of the algorithm, but should provide the
tools that HLL designers need in the interim. */
if (param_count > 2 || param_count == 0)
/* help branch predictors */;
else {
const INTVAL second_flag = raw_params[param_count - 1];
if (second_flag & PARROT_ARG_CALL_SIG) {
*accessor->pmc(interp, arg_info, param_count - 1) = call_object ? call_object : PMCNULL;
if (param_count == 1)
return;
}
}
/* First iterate over positional args and positional parameters. */
while (param_index < param_count) {
INTVAL param_flags = raw_params[param_index];
/* If it's a call_sig, we're done. */
if (param_flags & PARROT_ARG_CALL_SIG)
return;
/* If the parameter is slurpy, collect all remaining positional
* arguments into an array.*/
if (param_flags & PARROT_ARG_SLURPY_ARRAY) {
/* Can't handle named slurpy here, go to named argument handling */
if (!(param_flags & PARROT_ARG_NAME)) {
PMC *collect_positional;
int j;
INTVAL num_positionals = positional_args - arg_index;
if (num_positionals < 0)
num_positionals = 0;
if (named_count > 0) {
if (named_used_list != NULL)
Parrot_hash_destroy(interp, named_used_list);
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"named parameters must follow all positional parameters");
}
collect_positional = Parrot_pmc_new_init_int(interp,
Parrot_hll_get_ctx_HLL_type(interp, enum_class_ResizablePMCArray),
num_positionals);
for (j = 0; arg_index < positional_args; ++arg_index)
VTABLE_set_pmc_keyed_int(interp, collect_positional, j++,
VTABLE_get_pmc_keyed_int(interp, call_object, arg_index));
*accessor->pmc(interp, arg_info, param_index) = collect_positional;
++param_index;
}
break; /* Terminate the positional arg loop. */
}
/* We have a positional argument, fill the parameter with it. */
if (arg_index < positional_args) {
/* Fill a named parameter with a positional argument. */
if (param_flags & PARROT_ARG_NAME) {
STRING *param_name;
if (!(param_flags & PARROT_ARG_STRING)) {
if (named_used_list != NULL)
Parrot_hash_destroy(interp, named_used_list);
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"named parameters must have a name specified");
}
param_name = PARROT_ARG_CONSTANT_ISSET(param_flags)
? accessor->string_constant(interp, arg_info, param_index)
: *accessor->string(interp, arg_info, param_index);
++named_count;
++param_index;
if (param_index >= param_count)
continue;
param_flags = raw_params[param_index];
/* Mark the name as used, cannot be filled again. */
if (named_used_list == NULL) /* Only created if needed. */
named_used_list = Parrot_hash_create(interp,
enum_type_INTVAL, Hash_key_type_STRING);
Parrot_hash_put(interp, named_used_list, param_name, (void *)1);
}
else if (named_count > 0) {
if (named_used_list != NULL)
Parrot_hash_destroy(interp, named_used_list);
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION,
"named parameters must follow all positional parameters");
}
/* Check for :lookahead parameter goes here. */
/* Go ahead and fill the parameter with a positional argument. */
switch (PARROT_ARG_TYPE_MASK_MASK(param_flags)) {
case PARROT_ARG_PMC:
*accessor->pmc(interp, arg_info, param_index) =
VTABLE_get_pmc_keyed_int(interp, call_object, arg_index);
break;
case PARROT_ARG_STRING:
*accessor->string(interp, arg_info, param_index) =
VTABLE_get_string_keyed_int(interp, call_object, arg_index);
break;
case PARROT_ARG_INTVAL:
*accessor->intval(interp, arg_info, param_index) =
VTABLE_get_integer_keyed_int(interp, call_object, arg_index);
break;
case PARROT_ARG_FLOATVAL:
*accessor->numval(interp, arg_info, param_index) =
VTABLE_get_number_keyed_int(interp, call_object, arg_index);
break;
default:
if (named_used_list != NULL)
Parrot_hash_destroy(interp, named_used_list);
Parrot_ex_throw_from_c_args(interp, NULL,
EXCEPTION_INVALID_OPERATION, "invalid parameter type");
break;
}
/* Mark the option flag for the filled parameter. */
if (param_flags & PARROT_ARG_OPTIONAL) {
if (param_index + 1 < param_count) {
const int next_param_flags = raw_params[param_index + 1];
if (next_param_flags & PARROT_ARG_OPT_FLAG) {
++param_index;
*accessor->intval(interp, arg_info, param_index) = 1;
}
}
}
}
/* We have no more positional arguments, fill the optional parameter
* with a default value. */
else if (param_flags & PARROT_ARG_OPTIONAL) {
/* We don't handle optional named params here, handle them in the
* next loop. */
if (param_flags & PARROT_ARG_NAME)
break;
assign_default_param_value(interp, param_index, param_flags,
arg_info, accessor);
/* Mark the option flag for the parameter to FALSE, it was filled
* with a default value. */
if (param_index + 1 < param_count) {
const INTVAL next_param_flags = raw_params[param_index + 1];
if (next_param_flags & PARROT_ARG_OPT_FLAG) {
++param_index;
*accessor->intval(interp, arg_info, param_index) = 0;
}
}
}